Documentación de la API
Crea integraciones con la API REST de Buzzley. 49 endpoints en 14 grupos de recursos.
Autenticación
Todas las solicitudes a la API deben incluir tu API key en el encabezado Authorization usando el esquema Bearer. Puedes crear y administrar las API keys desde la página de API Keys.
curl https://api.buzzley.app/api/v1/reminders \
-H "Authorization: Bearer bzl_your_api_key_here"URL base
Todos los endpoints son relativos a:
https://api.buzzley.app/api/v1Límites de tasa
Tu cuenta puede hacer 60 solicitudes por minuto y 10.000 por día, compartidas entre todas sus API keys. Los siguientes encabezados de respuesta se incluyen en cada solicitud:
| Encabezado | Descripción |
|---|---|
| X-RateLimit-Limit | Máximo de solicitudes por minuto |
| X-RateLimit-Remaining | Solicitudes restantes en la ventana actual |
| X-RateLimit-Reset | Segundos hasta que se reinicie el límite de tasa |
Cuando se excede, se devuelve una respuesta 429 con un campo retry_after.
Formato de respuesta
Todas las respuestas son JSON. Las respuestas exitosas envuelven el payload en un campo data. Los errores contienen un objeto error con un code legible por máquina y un message legible por humanos.
// Success
{
"data": { ... }
}
// Error
{
"error": {
"code": "INVALID_REQUEST",
"message": "title is required"
}
}Códigos de error
| Estado | Código | Descripción |
|---|---|---|
| 400 | INVALID_REQUEST | El body o los parámetros de la solicitud no son válidos |
| 401 | UNAUTHORIZED | API key faltante o inválida |
| 403 | FORBIDDEN | La API key no tiene permiso para esta acción |
| 404 | NOT_FOUND | El recurso solicitado no existe |
| 409 | CONFLICT | El recurso ya existe o hay un conflicto de estado |
| 429 | RATE_LIMITED | Demasiadas solicitudes -- reintenta después del retraso especificado |
| 500 | INTERNAL_ERROR | Ocurrió un error inesperado en el servidor |
Referencia de endpoints (puntos de acceso)
Ping1 endpoint (punto de acceso)
API Keys (claves de API)1 endpoint (punto de acceso)
Una clave de API puede listar claves, pero no crearlas ni revocarlas, ni eliminar la cuenta: esas llamadas devuelven 403 con una clave de API. Crea y revoca claves en la página Claves de API con la sesión iniciada.
Recordatorios7 endpoints (puntos de acceso)
Instancias4 endpoints (puntos de acceso)
Las instancias representan ocurrencias individuales de un recordatorio recurrente.
Categorías4 endpoints (puntos de acceso)
Plantillas6 endpoints (puntos de acceso)
Preajustes de posposición4 endpoints (puntos de acceso)
Ajustes2 endpoints (puntos de acceso)
Grupo8 endpoints (puntos de acceso)
Cada cuenta pertenece a un grupo (familia, equipo o personal). Los límites de dispositivos se aplican a nivel de grupo. Las operaciones exclusivas del propietario requieren que el dueño de la API key sea el propietario del grupo.
Dispositivos2 endpoints (puntos de acceso)
Galería7 endpoints (puntos de acceso)
La galería de plantillas permite a los usuarios compartir e instalar plantillas creadas por la comunidad. Las plantillas con 3 o más reportes se ocultan automáticamente en espera de moderación.