API-Dokumentation
Erstelle Integrationen mit der Buzzley REST API. 49 Endpunkte in 14 Ressourcengruppen.
Authentifizierung
Alle API-Anfragen müssen deinen API Key (API-Schlüssel) im Authorization-Header mit dem Bearer-Schema enthalten. Du kannst API-Schlüssel auf der API-Schlüssel-Seite erstellen und verwalten.
curl https://api.buzzley.app/api/v1/reminders \
-H "Authorization: Bearer bzl_your_api_key_here"Basis-URL
Alle Endpunkte sind relativ zu:
https://api.buzzley.app/api/v1Ratenlimits
Dein Konto kann 60 Anfragen pro Minute und 10.000 pro Tag senden, gemeinsam für alle seine API Keys. Die folgenden Antwort-Header sind bei jeder Anfrage enthalten:
| Header | Beschreibung |
|---|---|
| X-RateLimit-Limit | Maximale Anfragen pro Minute |
| X-RateLimit-Remaining | Verbleibende Anfragen im aktuellen Fenster |
| X-RateLimit-Reset | Sekunden bis zum Zurücksetzen des Ratenlimits |
Bei Überschreitung wird eine 429-Antwort mit einem retry_after-Feld zurückgegeben.
Antwortformat
Alle Antworten sind JSON. Erfolgreiche Antworten verpacken die Nutzlast in einem data-Feld. Fehler enthalten ein error-Objekt mit einem maschinenlesbaren code und einer menschenlesbaren message.
// Success
{
"data": { ... }
}
// Error
{
"error": {
"code": "INVALID_REQUEST",
"message": "title is required"
}
}Fehlercodes
| Status | Code | Beschreibung |
|---|---|---|
| 400 | INVALID_REQUEST | Anfragekörper oder Parameter sind ungültig |
| 401 | UNAUTHORIZED | Fehlender oder ungültiger API Key |
| 403 | FORBIDDEN | Der API Key hat keine Berechtigung für diese Aktion |
| 404 | NOT_FOUND | Die angeforderte Ressource existiert nicht |
| 409 | CONFLICT | Ressource existiert bereits oder Statuskonflikt |
| 429 | RATE_LIMITED | Zu viele Anfragen. Versuche es nach der angegebenen Wartezeit erneut. |
| 500 | INTERNAL_ERROR | Ein unerwarteter Serverfehler ist aufgetreten |
Endpunkt-Referenz
Ping1 Endpunkt
API Keys (API-Schlüssel)1 Endpunkt
Ein API-Schlüssel kann Schlüssel auflisten, aber keine erstellen oder widerrufen und nicht das Konto löschen: Diese Aufrufe geben mit einem API-Schlüssel 403 zurück. Erstelle und widerrufe Schlüssel angemeldet auf der Seite API-Schlüssel.
Erinnerungen7 Endpunkte
Instanzen4 Endpunkte
Instanzen repräsentieren einzelne Vorkommen einer wiederkehrenden Erinnerung.
Kategorien4 Endpunkte
Vorlagen6 Endpunkte
Schlummer-Voreinstellungen4 Endpunkte
Einstellungen2 Endpunkte
Gruppe8 Endpunkte
Jedes Konto gehört zu einer Gruppe (Familie, Team oder persönlich). Gerätelimits werden auf Gruppenebene durchgesetzt. Nur-Besitzer-Aktionen erfordern, dass der API-Key-Besitzer auch der Gruppenbesitzer ist.
Geräte2 Endpunkte
Galerie7 Endpunkte
Die Vorlagengalerie ermöglicht es Nutzern, von der Community erstellte Vorlagen zu teilen und zu installieren. Vorlagen mit 3 oder mehr Meldungen werden automatisch bis zur Moderation ausgeblendet.