RufBusle/Entwickler
Dokumentation
GET/api/v1/me

Verbindungstest

Liefert Stadt und gewährte Rechte des verwendeten Schlüssels. Erster Aufruf jeder Integration.

Wofür

Nach dem Anlegen eines Schlüssels einmal aufrufen: Sie sehen sofort, welche Stadt am Schlüssel hängt und welche Rechte tatsächlich vergeben wurden. Eignet sich auch als Health-Check vor einem Nachtlauf.

Anfrage

Jeder gültige Schlüssel genügt — es wird kein besonderes Recht benötigt.
AnfrageShell
curl -sS \
  -H "Authorization: Bearer rb_live_…" \
  "https://rufbusle.de/api/v1/me"

Antwort

BeispielantwortJSON
{
  "id": "clx1a2b3c0000abcdefghijkl",
  "slug": "musterstadt",
  "name": "Musterstadt",
  "timezone": "Europe/Berlin",
  "scopes": [
    "read:schedule",
    "read:bookings"
  ]
}

Beispielwerte, keine echten Daten. Unbekannte Felder bitte ignorieren — es können jederzeit welche hinzukommen.

Felder

FeldTypBeschreibung
idstringInterne ID der Stadt.
slugstringKurzname der Stadt, wie er in öffentlichen Adressen vorkommt.
namestringAnzeigename der Stadt.
timezonestringZeitzone, in der alle „HH:MM"-Angaben zu lesen sind.
scopesstring[]Die diesem Schlüssel gewährten Scopes.

Worauf zu achten ist

Die Punkte, an denen Integrationen erfahrungsgemäß hängen bleiben.
  • Braucht keinen Scope — jeder gültige Schlüssel darf das.
  • Das Feld scopes ist die verlässliche Auskunft über die Rechte. Verlassen Sie sich nicht darauf, was beim Anlegen angeklickt wurde: Rechte können nachträglich geändert worden sein.