API
Mit der JamCloud-API kann ein Skript, eine Tabelle oder eine andere App deine Arbeitsbereiche lesen und ändern: Tracks auflisten, Dateien importieren, Abschnitte und Akkordblätter abrufen. Sie sieht genau das, was du siehst, in jedem Arbeitsbereich, dem du angehörst.
Deine API-Schlüssel
Abschnitt betitelt „Deine API-Schlüssel“Ein persönlicher Schlüssel (er beginnt mit jc_) vertritt dich gegenüber der API. Nicht jedes Konto enthält Schlüssel; ein Administrator kann dir den Zugang freischalten. Ohne ihn zeigt Einstellungen › API-Schlüssel, dass dein Konto keinen API-Zugang enthält.
Gib dem Schlüssel unter Einstellungen › API-Schlüssel einen Namen und wähle:
- Nur lesen: Der Schlüssel liest und ändert nie etwas.
- Lesen und schreiben: Der Schlüssel kann auch importieren, bearbeiten und löschen, im Rahmen deiner Rolle in jedem Arbeitsbereich.
- Den Ablauf: nie, oder in 30, 90 oder 365 Tagen.
Der Schlüssel wird nur einmal angezeigt, direkt nach Schlüssel erstellen: Kopiere ihn und bewahre ihn sicher auf, wie ein Passwort. Die Liste zeigt danach nur seinen Anfang, die letzte Nutzung und den Ablauf. Widerrufen stoppt einen Schlüssel sofort. Du kannst 10 aktive Schlüssel haben.
Einen Aufruf senden
Abschnitt betitelt „Einen Aufruf senden“Sende den Schlüssel im Header Authorization:
curl -H "Authorization: Bearer jc_…" https://api-jamcloud.australfactory.cl/api/v1/groupsDas listet deine Arbeitsbereiche. Die meisten anderen Routen liegen unter einem Arbeitsbereich (/api/v1/groups/<id>/…).
Was ein Schlüssel nicht kann
Abschnitt betitelt „Was ein Schlüssel nicht kann“Ein Schlüssel erreicht nie dein Konto: Anmeldung, Profil, Sicherheit, Benachrichtigungen, andere API-Schlüssel und Administration (/auth, /me, /admin, /realtime, /api-keys) antworten mit 403 und dem Code api_key_forbidden. Verwalte sie in der App. Ein Schlüssel mit Nur lesen, der etwas ändern will, erhält 403 api_key_read_only.
Ist die API vorübergehend abgeschaltet, erhält jeder Aufruf mit einem Schlüssel 503 circuit_open: Warte die Sekunden aus dem Header Retry-After ab und versuche es dann erneut. Die App selbst funktioniert weiter.
API-Referenz
Abschnitt betitelt „API-Referenz“Die API-Referenz (Version 1) listet jede Route, die ein Schlüssel aufrufen kann, mit Parametern, Feldern und einem lauffertigen Beispiel.