Übersicht

Diese Referenz wird direkt aus der Tillor-API generiert. Jeder Endpoint hat eine eigene Seite mit Parametern, Request-Body, möglichen Responses und Codebeispielen. In der Seitenleiste sind die Endpoints nach Thema gruppiert.

Einen Request sendenLink zu diesem Abschnitt kopieren

Jeder Request benötigt Ihren API-Schlüssel im Header x-api-key. Endpoints unter /orgs/{organizationId} arbeiten innerhalb einer Organisation.

GET https://api.tillor.eu/orgs/org_abc123/customers
x-api-key: tkn_xxx

Einen API-Schlüssel erstellen Sie in der App, unter Ihrem Konto. Wie das funktioniert, welche Rate Limits gelten und wie Sie Schlüssel sicher aufbewahren, lesen Sie unter HTTP API.

Wer einen Endpunkt aufrufen darfLink zu diesem Abschnitt kopieren

Jede Endpunktseite zeigt oben unter Zugriff, wer den Endpunkt aufrufen darf. Bei den meisten Endpunkten ist das ein Mitglied der Organisation mit einer bestimmten Berechtigung, etwa customers:read. Ein API-Schlüssel arbeitet mit den Berechtigungen der Person, die ihn erstellt hat; hat der Schlüssel Scopes, muss die Berechtigung auch darin stehen. Sonst antwortet die API mit 403.

In der Spezifikation steht dieselbe Information pro Endpunkt in x-tillor-access, mit access (wer) und permissions (eine davon genügt).

In der Playground ausprobierenLink zu diesem Abschnitt kopieren

Auf jeder Endpoint-Seite können Sie den Request sofort senden. Sind Sie im selben Browser bei Tillor angemeldet, verwendet die Playground Ihre Sitzung und Sie brauchen keinen API-Schlüssel. Andernfalls tragen Sie Ihren API-Schlüssel bei Authorization ein. Passen Sie die Parameter an und klicken Sie auf Send.

Die Playground spricht mit der echten API Ihrer Organisation: Ein POST, PUT oder DELETE ändert also echte Daten.

Spezifikation herunterladenLink zu diesem Abschnitt kopieren

Die vollständige Spezifikation steht als OpenAPI 3.1 unter tillor.eu/api/openapi.json. Importieren Sie sie in Postman oder Insomnia oder generieren Sie damit einen Client.

Siehe auchLink zu diesem Abschnitt kopieren