Documentation de l'API
Créez des intégrations avec l'API REST de Buzzley. 49 points de terminaison répartis en 14 groupes de ressources.
Authentification
Chaque requête API doit inclure votre clé API dans l'en-tête Authorization, avec le schéma Bearer. Vous pouvez créer et gérer vos clés API depuis la page Clés API.
curl https://api.buzzley.app/api/v1/reminders \
-H "Authorization: Bearer bzl_your_api_key_here"URL de base
Tous les points de terminaison sont relatifs à :
https://api.buzzley.app/api/v1Limites de débit
Votre compte peut effectuer 60 requêtes par minute et 10 000 par jour, partagées entre toutes ses clés API. Les en-têtes de réponse suivants accompagnent chaque requête :
| En-tête | Description |
|---|---|
| X-RateLimit-Limit | Nombre maximal de requêtes par minute |
| X-RateLimit-Remaining | Requêtes restantes dans la fenêtre en cours |
| X-RateLimit-Reset | Secondes avant la réinitialisation de la limite |
En cas de dépassement, une réponse 429 est renvoyée avec un champ retry_after.
Format des réponses
Toutes les réponses sont en JSON. Les réponses réussies placent les données dans un champ data. Les erreurs contiennent un objet error avec un code lisible par une machine et un message lisible par un humain.
// Success
{
"data": { ... }
}
// Error
{
"error": {
"code": "INVALID_REQUEST",
"message": "title is required"
}
}Codes d'erreur
| Statut | Code | Description |
|---|---|---|
| 400 | INVALID_REQUEST | Le corps ou les paramètres de la requête ne sont pas valides |
| 401 | UNAUTHORIZED | Clé API manquante ou non valide |
| 403 | FORBIDDEN | La clé API n'a pas l'autorisation pour cette action |
| 404 | NOT_FOUND | La ressource demandée n'existe pas |
| 409 | CONFLICT | La ressource existe déjà ou son état est en conflit |
| 429 | RATE_LIMITED | Trop de requêtes : réessayez après le délai indiqué |
| 500 | INTERNAL_ERROR | Une erreur serveur inattendue s'est produite |
Référence des points de terminaison
Ping1 point de terminaison
Clés API1 point de terminaison
Une clé API peut lister les clés, mais ne peut ni en créer, ni en révoquer, ni supprimer le compte : ces appels renvoient 403 pour une clé API. Créez et révoquez les clés sur la page Clés API en étant connecté.
Rappels7 points de terminaison
Occurrences4 points de terminaison
Les occurrences représentent chacune des échéances d'un rappel récurrent.
Catégories4 points de terminaison
Modèles6 points de terminaison
Durées de report4 points de terminaison
Paramètres2 points de terminaison
Groupe8 points de terminaison
Chaque compte appartient à un groupe (famille, équipe ou personnel). Les limites d'appareils s'appliquent au niveau du groupe. Les opérations réservées au propriétaire exigent que le propriétaire de la clé API soit le propriétaire du groupe.
Appareils2 points de terminaison
Galerie7 points de terminaison
La galerie de modèles permet de partager et d'installer des modèles créés par la communauté. Les modèles signalés 3 fois ou plus sont masqués automatiquement en attendant la modération.