Wer andere Tools an seine Xentral ERP-Software anknüpfen möchte, kommt an ihnen nicht vorbei: den Xentral APIs. Auch wenn du als Programmier-Laie glaubst, einen nahezu unbesiegbaren Endgegner vor dir zu haben, vergiss die vielen Vorteile nicht. Bei den Xentral APIs handelt es sich um wichtige Werkzeuge für deinen E-Commerce. Sie erhöhen die Prozesseffizienz, führen zu einer höheren Markenbekanntheit und verbessern die organisatorischen Abläufe. Außerdem helfen sie dir, dein Unternehmen mit Kunden, Auftragsgebern und Mitarbeitern zu verbinden.
Doch was genau ist eine API? Welche Xentral APIs gibt es und wo findest du die benötigte Dokumentation zu den Xentral Programmierschnittstellen? In unserem Ratgeber erfährst du alles, was du über die Xentral API wissen musst.
Was ist eine API?
Eine API (kurz für Application Programming Interface) ist eine Programmierschnittstelle, die den Datentransfer zwischen Programmen ermöglicht oder als Zugangspunkt dient. Dabei handelt es sich um Befehle, Funktionen, Protokolle und Objekte, kurz gesagt: um den Code. Dieser bietet Entwicklern eine große Auswahl an Standardbefehlen für die Ausführung unterschiedlicher Operationen. Die Anbindung wird stets auf Quellcode-Ebene ausgeführt.
Du kannst auf eine API zurückgreifen, um eine Software zu erstellen oder die Kommunikation zwischen mehreren Systemen herzustellen. Mithilfe einer API öffnest du also die Türe zwischen zwei Softwares, sodass diese miteinander kommunizieren können. Eine API definiert dabei genau, in welcher Form Informationen angefordert und zurückgesendet werden.
Dank des breiten Angebots an unterschiedlichen APIs ersparen sich viele Programmierer das eigenständige Codieren. Zudem wird der Datenaustausch zwischen den Programmen um ein Vielfaches beschleunigt.
Welche Xentral APIs gibt es?
Xentral bietet derzeit zwei APIs an:
- Xentral Standard-API
- Xentral REST-API
Die REST-API gibt es seit der Xentral Version 18.3. Falls du also noch unschlüssig bist, empfehlen wir dir, die Xentral REST-API zu installieren. Sie umfasst alle Funktionen der Standard-API und soll zukünftig weiter ausgebaut werden und letztlich die alten API-Abrufe ablösen.
Um eine dieser beiden APIs zu verwenden, bedarf es einer umfangreichen Dokumentation zu den diversen Funktionen, der exakten Syntax und etwaigen Parametern.
Wo finde ich die Dokumentation zur Xentral Standard-API?
Die Dokumentation für die Standard Xentral API findest du auf der Developer-Website von Xentral. Neben einer ausführlichen Einführung findest du dort auch alle Xentral API-Funktionen wie „Customer“, „Invoice“ und „Supplier“.
Tipp: Statt der Anbindung der Standard-API über die Hash-Authentifizierung empfehlen wir dir die REST-API. Mit der REST-API kannst du die gleichen Funktionsaufrufe wie mit der Standard-API vornehmen.
Wo finde ich die Dokumentation zur Xentral REST-API?
Die Dokumentation zur Xentral REST-API ist bei der Installation dabei (siehe Verzeichnis www/api/docs.html). Dort findest du alle Infos rund um die API-Accounts, -Ressourcen und -Endpunkte. Um zur Dokumentation zu gelangen, rufe „instanzname/www/api/docs.html“ auf. Sollte das nicht klappen, gibt es die Dokumentation zur Xentral REST-API online.
Tipp: Seit der Version 22.1x ist die Hash-Authentifizierung nicht mehr notwendig und möglich. Stattdessen wird DIGEST für die REST-API verwendet.
Was ist der Unterschied zwischen einer API und einer REST-API?
Eine API und eine REST-API – auch RESTful API genannt – unterscheiden sich durch folgende Punkte:
API vs. REST-API: Struktur
Die meisten APIs folgen strukturell dem Format Anwendung-Anwendung. Die REST-API hingegen arbeitet streng nach dem Webkonzept von Client-Server. Der Client und der Server sind voneinander getrennt, was zu mehr Flexibilität führt.
API vs. REST-API: Design
Im Allgemeinen haben APIs eine einfache Architektur, die etwa für Gadgets, die auf Smartphones beschränkt sind, konzipiert wurde. Im Gegensatz dazu kommunizieren REST-APIs mit ganzen Systemen. Ihre Architektur ist wesentlich komplexer.
API vs. REST-API: Protokoll
Das Ziel einer API ist die Standardisierung des Datentransfers zwischen zwei Webdiensten. Je nach API-Art ändert sich die Wahl des Protokolls. Die Architektur der REST-API dagegen ist auf den Aufbau von Webservices, die über ein http-Protokoll interagieren, spezialisiert. REST-APIs werden vor allem für öffentliche APIs verwendet.
API vs. REST-API: Support
Die meisten APIs sind einfach zu implementieren, da sie nicht zustandslos sind. Im Gegensatz dazu wird die REST-API auch dann ausgeführt, wenn die Nutzer die Funktionsnamen und die Parameter nicht in einer bestimmten Reihenfolge kennen.
API vs. REST-API: einheitliche Schnittstelle
Nur wenige APIs entkoppeln den Client von einem Server oder eine Anwendung von einer anderen. Die REST-API hält sich an die Grundsätze einer einheitlichen Schnittstelle und verbietet die Verwendung eigener oder mehrerer Schnittstellen innerhalb einer API.
Zudem stellen hypermediale Verbindungen eine einzige Schnittstelle bereit. Außerdem sollte ein ähnliches Datenelement (z. B. der Name oder die E-Mail-Adresse eines Nutzers) nur zu einem Uniform-Resource-Identifier (URI) gehören. Infolgedessen sollten alle API-Anfragen für dieselben Ressourcen unabhängig von der ursprünglichen Anfrage einheitlich sein.
API vs. REST-API: Skalierbarkeit
Die Skalierbarkeit stellt für APIs immer wieder einer Herausforderung dar. Dank der mehrschichtigen Struktur der REST-API ist diese flexibler und somit anpassungsfähiger.
Wie funktioniert die Xentral API-Rechtevergabe?
Bei der API-Anbindung an Xentral hast du die Möglichkeit, eine Rechtevergabe vorzunehmen. Egal, welche Software du mit Xentral verbindest, mit der API-Rechtevergabe hast du es in der Hand. Du entscheidest per Klick, welche Rechte die angebundenen Tools auch in Xentral ausüben dürfen.
- Suche dafür in der Smart Search nach „API-Account“.
- Öffne dann einen der angelegten API-Accounts.
- Hier siehst du pro Einzelrecht eine Checkbox, sortiert nach den unterschiedlichen Modulen.
- Mit einem Klick aktivierst du die Rechte, die du der angebundenen Software geben möchtest.
Tipp: In der API-Dokumentation findest du alle Informationen zu den einzelnen Rechten.
Falls du noch weitere Fragen zur Xentral API hast oder individuelle Hilfe bei der Xentral REST-API benötigst, füll einfach unser Kontaktformular aus oder buche einen kostenlosen Beratungstermin. Die Xentral Experten von BDG Solutions kümmern sich dann um dein Anliegen.
