/
PEIQ PRINT NGEN - API-Schnittstellen

PEIQ Knowledge Base

PEIQ PRINT NGEN - API-Schnittstellen

Auf den folgenden untergeordneten Seiten sind die API-Schnittstellen zur Anbindung von PEIQ PRINT NGEN an weitere PEIQ-Produkte sowie Systeme von Drittanbietern zu finden.


Besondere Hinweise zur Arbeit mit allen API-Schnittstellen

Insbesondere bei Updates ist es wichtig, dass das Absetzen von Requests sequenziell erfolgt. Erst nach Erhalt der Response darf erneut ein Request zum selben Element (z.B. Artikel, Bild) geschickt werden. Andernfalls können in PRINT NGEN Fehler an den betroffenen Elementen auftreten.

Funktionalitäten der PEIQ APIs

Die PEIQ APIs ermöglichen es Kund:innen, externe Systeme und Dienste eigenständig mit PEIQ zu integrieren. Sie basieren in der Regel auf der REST-Architektur und nutzen die Standard-HTTP-Methoden (GET, POST, PUT, DELETE) für den Zugriff.

Die APIs sind fehlertolerant gestaltet: Unbekannte oder unerwartete Felder in JSON-Anfragen werden ignoriert, während valide Daten weiterhin verarbeitet werden. Für die Zugriffskontrolle kommt der OAuth-V2-Standard zum Einsatz.

Zur Unterstützung der Nutzung stehen umfassende Dokumentationen bereit, darunter eine interaktive Entwicklerdokumentation sowie Swagger-Dokumentationen aller verfügbaren Endpunkte. Zudem werden mögliche Anwendungsfälle und Einsatzszenarien beschrieben.

Kernfunktionen im Überblick:

  • Anbindung bestehender Systeme und Produkte

  • REST-basierte API-Nutzung mit Standard-HTTP-Methoden

  • Fehlertolerante Verarbeitung von JSON-Anfragen

  • Zugriffskontrolle über OAuth-V2

  • Interaktive Entwicklerdokumentation (inkl. Swagger)

  • Dokumentation von Anwendungsmöglichkeiten und Use Cases

Nach einer Schnittstelle suchen

Seitenübersicht