API-Referenz

Das tebio Business-Portal bietet REST-API-Services für die Integration externer Systeme. Dazu gehören unter anderem Subscription Management, Zahlungsabwicklung, Gutscheinverwaltung (Voucher Management) sowie die Verwaltung externer Partnerprodukte.

Alle Services werden als REST-APIs im OpenAPI-Format (ecobc_openapi.json oder ecobc_openapi.yaml) bereitgestellt und können direkt über die integrierte API-Dokumentation getestet werden.

Wann brauche ich diese Funktion?

Nutzen Sie die API-Referenz, wenn Sie:

externe Systeme (wie ERP, CRM, Webshops) mit tebio integrieren möchten.
Genaue Informationen zu Endpunkten, HTTP-Methoden, Payload-Strukturen und möglichen Fehlercodes benötigen.
Test-Requests (Try it out) direkt im Browser ausführen wollen, um das Verhalten der API zu testen.

Voraussetzungen

Sie benötigen zudem einen aktiven API-Schlüssel, falls Sie die Endpunkte über den interaktiven Modus der Referenz testen möchten.

API-Referenz öffnen

Melden Sie sich mit Ihren Benutzerdaten im tebio Business-Portal an.
Navigieren Sie über das Terminal-Symbol (oben rechts) in den Bereich Entwickler.
Klicken Sie auf den Reiter Dokumentation (Dokumentation oder API-Referenz, je nach Bezeichnung in Ihrem Portal).
Sie sehen nun die interaktive OpenAPI-Oberfläche, in der alle verfügbaren API-Bereiche (wie Billing, Client, Customer, Order, Payment, weitere) strukturiert aufgelistet sind.

Ergebnis

Die API-Referenz wird geöffnet. Dort können Sie verfügbare Endpunkte, Methoden, Request- und Response-Strukturen sowie Fehlercodes einsehen.