API-documentatie
Bouw integraties met de REST API van Buzzley. 49 endpoints in 14 resourcegroepen.
Authenticatie
Elk API-verzoek moet je API-sleutel meesturen in de header Authorization, volgens het Bearer-schema. Je maakt en beheert API-sleutels op de pagina API-sleutels.
curl https://api.buzzley.app/api/v1/reminders \
-H "Authorization: Bearer bzl_your_api_key_here"Basis-URL
Alle endpoints zijn relatief ten opzichte van:
https://api.buzzley.app/api/v1Rate limits
Je account kan 60 verzoeken per minuut en 10.000 per dag doen, gedeeld over al zijn API-sleutels. Bij elk verzoek krijg je deze headers terug in de response:
| Header | Beschrijving |
|---|---|
| X-RateLimit-Limit | Maximaal aantal verzoeken per minuut |
| X-RateLimit-Remaining | Resterende verzoeken in het huidige venster |
| X-RateLimit-Reset | Seconden tot de rate limit wordt gereset |
Ga je daaroverheen, dan krijg je een 429-response met een veld retry_after.
Responseformaat
Alle responses zijn JSON. Bij een geslaagde response staat de payload in een veld data. Een fout bevat een object error met een machineleesbare code en een voor mensen leesbare message.
// Success
{
"data": { ... }
}
// Error
{
"error": {
"code": "INVALID_REQUEST",
"message": "title is required"
}
}Foutcodes
| Status | Code | Beschrijving |
|---|---|---|
| 400 | INVALID_REQUEST | De request-body of parameters zijn ongeldig |
| 401 | UNAUTHORIZED | API-sleutel ontbreekt of is ongeldig |
| 403 | FORBIDDEN | De API-sleutel heeft geen toestemming voor deze actie |
| 404 | NOT_FOUND | De gevraagde resource bestaat niet |
| 409 | CONFLICT | De resource bestaat al of er is een conflict in de status |
| 429 | RATE_LIMITED | Te veel verzoeken. Probeer het opnieuw na de opgegeven wachttijd |
| 500 | INTERNAL_ERROR | Er is een onverwachte serverfout opgetreden |
Overzicht van endpoints
Ping1 endpoint
API-sleutels1 endpoint
Met een API-sleutel kun je sleutels opvragen, maar geen sleutels aanmaken of intrekken en het account niet verwijderen: die calls geven 403 terug voor een API-sleutel. Maak sleutels aan en trek ze in op de pagina API-sleutels terwijl je bent ingelogd.
Herinneringen7 endpoints
Instanties4 endpoints
Een instantie is één afzonderlijke keer dat een terugkerende herinnering voorkomt.
Categorieën4 endpoints
Sjablonen6 endpoints
Snoozevoorinstellingen4 endpoints
Instellingen2 endpoints
Deelgroep8 endpoints
Elk account hoort bij een groep (gezin, team of persoonlijk). Apparaatlimieten gelden op groepsniveau. Voor acties die alleen de eigenaar mag uitvoeren, moet de eigenaar van de API-sleutel ook de eigenaar van de groep zijn.
Apparaten2 endpoints
Galerij7 endpoints
In de sjabloongalerij kunnen gebruikers sjablonen uit de community delen en installeren. Sjablonen met 3 of meer markeringen worden automatisch verborgen tot ze zijn gemodereerd.