API – Allgemeine Informationen

Die ERP XT-API von Comarch basiert auf dem HTTP-Protokoll. Es stehen die Methoden (GET, POST, PUT, DELETE) zur Verfügung. Die Autorisierung erfolgt im OAuth 2.0-Standard (mehr zur Autorisierung – hier klicken).

Der Zugriff auf die API erfolgt über eine HTTPS-Verbindung zum Server app.erpxt.de. Daten werden im JSON-Format vom Server gesendet und empfangen.

Der Zugriff auf die API ist über die Ebene Mein Konto >> Konto verwalten >> ÖFFENTLICHE API möglich. Der Benutzer, der der Administrator des Comarch ERP XT-Kontos ist, fordert den Zugriff an (die Option „Nach API Anfragen”). Jetzt generieren wir die API-Zugriffsschlüsseln für die jeweilige Anwendung.

1-API-Allgemeine-Informationen

Verwendete HTTP-Methoden:

GET Herunterladen von Dokumenten und allen ausgewählten Elementen
POST Erstellen eines neuen Elements
PUT Bearbeiten eines vorhandenen Elements
DELETE Löschen eines Elements

Quellen:

Produkte https://app.erpxt.de/api2/public/products
Kunden/Lieferanten https://app.erpxt.de/api2/public/customers
Zahlungsmethoden https://app.erpxt.de/api2/public/paymenttypes
Bankkonten https://app.erpxt.de/api2/public/bankaccounts
Ausgangsrechnungen https://app.erpxt.de/api2/public/invoices
Aufträge https://app.erpxt.de/api2/public/proformas
Benutzerdefinierte Ausdrucke https://app.erpxt.de/api2/public/customprints

Jede Anfrage an die API gibt den HTTP-Status zurück, der über das Verarbeitungsergebnis informiert. Die folgende Liste enthält die am häufigsten verwendeten Statuse:

  • 200 OK – Daten wurden erfolgreich mit der GET, POST-Methode gesendet
  • 204 No Content – Die Aktion wurde in der Methode PUT, DELETE erfolgreich abgeschlossen
  • 400 Bad Request – Fehler im Inhalt der Anfrage
  • 401 Unauthorized – Keine Autorisierung
  • 403 Forbidden – Zugang gesperrt
  • 404 Not Found – Ressource nicht gefunden
  • 405 Method Not Allowed – Nicht unterstützte Methode
  • 500 Internal Server Error – Interner Serverfehler

Über die API ausgeführte Vorgänge werden in der Historie der Auftragnehmer- und Dokumentänderungen gespeichert. Die Operationsbeschreibung enthält Informationen zum Namen der Anwendung, über die die Änderungen vorgenommen wurden.

 

HINWEIS
Der Comarch ERP XT-Benutzer kann die API auch verwenden, wenn er über eine Testversion der Anwendung verfügt.

 

 

Czy ten artykuł był pomocny?