Webshops greifen auf Artikel, Bestände, Preise und Bestellungen zu, bidirektional.
REST-API · Für Entwickler und Integratoren
Ihre Plattform
für andere Systeme öffnen.
REST-API öffnet Ihre Plattform für Drittsysteme. Pro Modul erweiterbar, vollständig mit OpenAPI dokumentiert, versioniert. OData-Unterstützung für IoT-Anbindung an Maschinensteuerungen und externe Datenquellen. In Intrexx-Installationen standardmäßig enthalten.
- REST-Endpoints für alle *Syn-Module. OpenAPI 3.0 dokumentiert
- OData-Support für IoT-Anbindung und externe Datenquellen
OAuth2 und API-Keys · Rate-Limiting · Versionierung · Request-Logs
Das Problem
Warum REST-API?
Jede Datenquelle, die nicht per Maus erreichbar ist, braucht eine Schnittstelle. Shop-Systeme wollen Artikel lesen, Lieferanten-Portale senden Bestellungen, Maschinen liefern Messdaten, Telefonanlagen öffnen Tickets. Die REST-API gibt allen strukturierten Zugriff auf Ihre *Syn-Plattform, ohne Extra-Entwicklung pro Fall.
Funktionen
Was REST-API kann.
- 01
REST-Endpoints für alle Plattform-Module
- 02
OpenAPI 3.0 Dokumentation (Swagger)
- 03
Versionierung (v1, v2, ...). Rückwärtskompatibilität gesichert
- 04
OData-Support für IoT und Maschinenanbindung
- 05
OAuth2 / API-Key Authentifizierung
- 06
Rate-Limiting und Request-Logs
Einsatzorte
In welche Module passt REST-API?
REST-API dockt dort an, wo es gebraucht wird, ohne zusätzlichen Integrationsaufwand.
Drittsysteme pushen Belege zu oder lesen Rechnungs-Statuswerte.
Maschinen liefern per OData Betriebsdaten, empfangen Auftrags-Informationen.
Web-Formulare und Lead-Quellen legen direkt Kontakte und Opportunities an.
Telefonanlagen und Monitoring-Systeme erstellen automatisch Tickets.
Konkrete Beispiele
So sieht das im Alltag aus.
Im E-Commerce
Shopify greift auf Bestände zu
Shopify-Storefront fragt alle 10 Minuten via REST /wawi/articles ab, bekommt aktuelle Preise und Bestände. Bei Bestellung pusht Shopify die Order. WaWiSyn bucht aus, BelegSyn erzeugt Rechnung.
In der Fertigung
Maschine meldet Taktzeiten
Siemens-SPS liefert alle 60 Sekunden via OData die aktuelle Stückzahl. IndustrieSyn berechnet OEE live, Überwachungs-Dashboard zeigt Anomalien, ohne manuelle Meldung.
Im Support
Telefonanlage öffnet Tickets
Anruf geht verpasst rein → Telefonanlage ruft POST /service/tickets auf mit Rufnummer und Zeitstempel. ServiceSyn ordnet dem Kontakt zu, öffnet Ticket, benachrichtigt Disposition.
Technische Details
Was unter der Haube steckt.
Protokolle
REST (JSON) OData v4 GraphQL (auf Anfrage) Webhooks (Event-basiert)
Authentifizierung
OAuth2 (Bearer Token) API-Key (Header) mTLS für Maschinen IP-Whitelisting
Dokumentation
OpenAPI 3.0 (Swagger UI) Code-Beispiele (curl, JavaScript, Python, PHP) Postman-Collection Sandbox-Umgebung
Betrieb
Rate-Limiting (konfigurierbar) Request-Logs mit Retention Versionierung (/v1/, /v2/) Deprecation-Warnings
Häufige Fragen
Fragen und Antworten zu REST-API.
Was kostet die REST-API?
Als Intrexx-Installation ist sie im Standard enthalten. Als SaaS-Add-On Flat-Preis pro Monat, unabhängig vom Request-Volumen (innerhalb Fair-Use-Grenzen). Details in der Preisliste.
Wie stabil sind die Endpoints?
Versioniert, eine neue API-Version lässt die alte mindestens 12 Monate weiterlaufen. Breaking Changes werden 3 Monate vorher angekündigt, Deprecation-Warnings gehen mit jedem Response mit.
Können wir eigene Endpoints hinzufügen?
Ja, pro Datenmodul sind kundenindividuelle Endpoints möglich. Sie spezifizieren OpenAPI, wir implementieren und testen.
Gibt es eine Sandbox zum Testen?
Ja. Jeder Kunde bekommt eine Staging-Umgebung mit Testdaten für Entwickler, um Integrationen ohne Risiko zu bauen. Swagger-UI und Postman-Collection inklusive.
REST-API live sehen.
Kostenlose Demo und Erstgespräch, wir zeigen Ihnen REST-API an Ihrem konkreten Anwendungsfall. Antwort innerhalb eines Werktags.