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.
...
General information
Through the API, all available data within the system can be downloaded and processed. The API provides various parameters that need to be specified in order to access the relevant data.
Possible parameter to filter the data
Filtering is applied through specific parameters to get only the necessary data.
An example API call looks as follows:
https://www.domain.de/api//ACCESS-TOKEN/admin/ID/get-orders.csv?condition[period][from]=01.01.19942023&condition[period][to]=01.01.19942023&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:
Anschließend wird die Art des API Aufrufs bestimmt. Welche hierbei zur Verfügung stehen kann folgenden Anleitungen entnommen werden:
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
...
Dateiformat
...
Parameter
...
CSV Dateiformat - Kommagetrennt
...
.csv
...
To access information via the API, you need to replace the domain, access token, and ID in the link mentioned above with the correct data. If a .csv format is not desired, you will also need to replace the file format. The .csv format is recommended.
available file formats
File format | Parameter |
|---|---|
CSV file format - comma-separated | .csv |
JSON file format - JavaScript Object Notation | .json |
XLS |
file format - standard file format Microsoft Excel | .xls |
XML |
file format - |
file format Microsoft Excel | .xml |
API
...
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.
...
in admin interface
The frontend provides access to the APIs as well. Once you are logged in, you can locate them by navigating to the “API” tab and selecting “Data-API”. This section contains a comprehensive list of all available APIs.