EN -Admin API

Allgemeine Informationen

Über die API können sämtliche Daten, welche im System zur Verfügung stehen, heruntergeladen und verarbeitet werden. Die API besteht aus verschiedenen Parametern, die angegeben werden müssen, um Zugriff auf die richtigen Daten zu erhalten.

Mögliche Parameter zur Filterung:

Über die API können sämtliche Daten, welche im laufe der Zeit in das System geflossen sind, aufgerufen werden. Über die entsprechenden Parameter wird eine Filterung angewendet, um nur die Daten abzufragen, welche benötigt werden.

Ein Beispielhafter API-Aufruf sieht folgendermaßen aus:

https://www.domain.de/api//ACCESS-TOKEN/admin/ID/get-orders.csv?condition[period][from]=01.01.1994&condition[period][to]=01.01.1994&condition[paymentstatus]=all

Um die API aufzurufen, muss zuerst die Domain des entsprechenden Systems hinterlegt werden. Anschließend folgt “/api//” und der Access-Token des Accounts. Wenn der Access-Token nicht bekannt ist, bitte folgender Anleitung folgen:

Wo ist der Access-Token zu finden?

Nun wird nach dem Access-Token ein “/admin/” angehangen und anschließend die User ID innerhalb des Systems angefügt. Wenn der User-ID nicht bekannt ist, bitte folgender Anleitung folgen:

Wo ist die User ID zu finden?

Anschließend wird die Art des API Aufrufs bestimmt. Welche hierbei zur Verfügung stehen kann folgenden Anleitungen entnommen werden:

Welche API Aufrufe gibt es?

Zum Schluss kann entschieden werden, in welchem Format die Daten bereitgestellt werden sollen. Die Ausgabe der Datei ist in CSV, XLS, XML sowie JSON möglich. Hierfür muss die Datei-Endung entsprechend angepasst werden. Das CSV Dateiformat wird empfohlen!

Verfügbare Datenarten

API im Frontend einsehen

Die APIs sind ebenfalls im Frontend zu finden. Dazu muss im eingeloggten Zustand über den Reiter API auf den Punkt Daten-API navigiert werden, wo alle Schnittstellen angeboten werden.