Playground

Der tebio Playground ist eine öffentliche Testumgebung. Hier können Sie verschiedene API-Dienste testen, ohne produktive Kundendaten zu verändern oder ein eigenes Setup konfigurieren zu müssen.

Wann brauche ich diese Funktion?

Nutzen Sie den Playground, wenn Sie:

Neue Integrationen (z. B. Zahlungen oder Kundenanlage) programmieren und testen möchten, bevor Sie diese produktiv nutzen.
Sich mit den Datenstrukturen und Payloads der tebio-API vertraut machen wollen.
Die in der API-Referenz dokumentierten Endpunkte live ausprobieren (“Try it out”), ohne Auswirkungen auf produktive Daten zu haben.

Voraussetzungen

Im Gegensatz zu produktiven Mandanten benötigen Sie für den Playground keine eigenen Zugangsdaten. Der Playground ist so vorkonfiguriert, dass Sie sofort starten können.

So funktioniert der Playground

Der Playground basiert auf einem öffentlichen, eingeschränkten Setup. Sie nutzen für Ihre API-Aufrufe einfach die folgenden vordefinierten Authentifizierungs- und Zuordnungsdaten:

Öffentlicher API-Schlüssel: demo-1518-452d-b6d8-4d47db61b9eb
Vordefinierter Client: a1b2c3d4
Vordefinierter Mandant: ten1b2c3

Hinweis: In unserer webbasierten API-Referenz sind viele Beispieldatenfelder bereits mit genau diesen Werten vorbelegt. Sie können die Dienste also sofort ausprobieren, ohne IDs manuell zusammensuchen zu müssen.

Unterstützte Test-Szenarien

Die Beispieldaten des Playgrounds sind speziell darauf ausgelegt, folgende API-Aufrufe ohne weitere Konfiguration direkt testen zu können:

Basisverwaltung:

Retrieve a client (Client abrufen)
List api keys (API-Schlüssel auflisten)
List tenants (Mandanten auflisten)

Kunden und Vertrieb:

Search customers (Kunden suchen)
Search sales partners (Vertriebspartner suchen)

Dokumente und Webhooks:

List document types (Dokumententypen auflisten)
Search document types (Dokumententypen suchen)
Create eventType setting (Event-Typ-Einstellungen anlegen)
Search Webhook endpoints (Webhook-Endpunkte suchen)

Zahlungen und Gutscheine:

List payment methods (Zahlungsmethoden auflisten)
Get voucher info (simplified) (Gutscheininformationen abrufen). Hinweis: Es existiert ein mehrfach verwendbarer Testgutschein mit dem Code ABCDEFGHIJK und einem Wert von 1,99 EUR.
Start payment (Zahlung starten): Sie können fiktive Zahlungen auf Basis des oben genannten Testgutscheins (ABCDEFGHIJK) simulieren.

Identifikation:

Create EID transaction (eID-Transaktion erstellen)

Datenbereinigung (Cleanup)

Da der Playground eine öffentliche Testumgebung ist, sorgt das System automatisch für einen bereinigten Zustand.

Ergebnis

Sie können API-Endpunkte im Playground testen, ohne produktive Daten zu verändern. Beachten Sie, dass Testdaten regelmäßig bereinigt werden.