A versão em inglês desta documentação é a referência oficial. Esta tradução é oferecida apenas por conveniência e pode não estar totalmente atualizada.

Documentação da API

Crie integrações com a API REST do Buzzley. 49 endpoints em 14 grupos de recursos.

Autenticação

Todas as solicitações à API precisam incluir sua chave de API no cabeçalho Authorization, com o esquema Bearer. Você pode criar e gerenciar chaves de API na página Chaves de API.

curl https://api.buzzley.app/api/v1/reminders \
  -H "Authorization: Bearer bzl_your_api_key_here"

URL base

Todos os endpoints são relativos a:

https://api.buzzley.app/api/v1

Limites de uso

Sua conta pode fazer 60 solicitações por minuto e 10.000 por dia, divididas entre todas as chaves de API dela. Os cabeçalhos de resposta abaixo vêm em todas as solicitações:

Cabeçalho	Descrição
X-RateLimit-Limit	Máximo de solicitações por minuto
X-RateLimit-Remaining	Solicitações restantes na janela atual
X-RateLimit-Reset	Segundos até o limite ser reiniciado

Quando o limite é ultrapassado, a resposta é 429, com um campo retry_after.

Formato da resposta

Todas as respostas são em JSON. As respostas de sucesso trazem os dados em um campo data. Os erros trazem um objeto error com um code legível por máquina e uma message legível por pessoas.

// Success
{
  "data": { ... }
}

// Error
{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "title is required"
  }
}

Códigos de erro

Status	Código	Descrição
400	INVALID_REQUEST	O corpo ou os parâmetros da solicitação são inválidos
401	UNAUTHORIZED	Chave de API ausente ou inválida
403	FORBIDDEN	A chave de API não tem permissão para esta ação
404	NOT_FOUND	O recurso solicitado não existe
409	CONFLICT	O recurso já existe ou há um conflito de estado
429	RATE_LIMITED	Solicitações demais: tente de novo após o tempo indicado
500	INTERNAL_ERROR	Ocorreu um erro inesperado no servidor

Referência dos endpoints

Ping1 endpoint

Chaves de API1 endpoint

Uma chave de API pode listar chaves, mas não pode criá-las, revogá-las nem excluir a conta: essas chamadas retornam 403 para uma chave de API. Crie e revogue chaves na página Chaves de API, com a sessão iniciada.

Lembretes7 endpoints

Ocorrências4 endpoints

As ocorrências representam cada vez que um lembrete recorrente acontece.

Categorias4 endpoints

Modelos6 endpoints

Opções de adiamento4 endpoints

Configurações2 endpoints

Grupo8 endpoints

Toda conta pertence a um grupo (família, equipe ou pessoal). Os limites de dispositivos valem para o grupo. As operações exclusivas do dono exigem que o dono da chave de API seja o dono do grupo.

Dispositivos2 endpoints

Galeria7 endpoints

A galeria de modelos permite que os usuários compartilhem e instalem modelos criados pela comunidade. Modelos com 3 ou mais denúncias ficam ocultos automaticamente até a moderação.