In xentral existieren derzeit zwei APIs:
-
REST-API
-
Standard-API
Ausführlichere Informationen dazu findest du hier.
Die Dokumentation zur REST-API ist in der xentral Installation, passend zur installierten Version, unter www/api/docs.html zu finden. Dort wird u.a. erklärt
-
wie ein API-Account anzulegen ist
-
wie Anfragen an API-Ressourcen zu gestalten sind und
-
welche API-Endpunkte existieren.
Die API-Dokumentation wird mit xentral ausgeliefert und kann in jeder xentral-Instanz unter instanzname/www/api/docs.html im Browser aufgerufen werden. Oft wird das /www/ jedoch nicht benötigt. Alternativ ist die API-Dokumentation, nach Versionen gegliedert, auch online zu finden: https://update.xentral.biz/apidoc/docs211.html
Prinzipiell kann die Version im Pfadname angegeben werden, Die Version 21.1 findet sich beispielsweise im Pfad docs211.html.
In der Dokumentation der Rest-API sind die Informationen
-
über den Debug-Modus
-
über die Fehlercodes
-
zur Webserver-Konfiguration für Apache und Nginx
-
für den Zugriff auf Test-Datenbanken (auch Test- oder MultiDB-Systeme, ab Version 20.1) enthalten.
Zur xentral Standard-API sind Dokumentation und Praxisbeispiele online zu finden.
Anmerkung
Im Zweifelsfall ist die REST-API bei der Integration vorzuziehen. Die Funktionen der Standard-API werden zukünftig auch in der REST-API verfügbar sein.
Informationen, Definitionen und verfügbare Funktionen sind in der xentral Dokumentation Standard-API einzusehen.