Visao geral
A API do BeePass oferece acesso programatico aos seus dados de criacao: rainhas, avaliacoes, valores geneticos estimados (EBV), pedigrees e exportacoes. Todas as operacoes disponiveis na interface web sao acessiveis atraves da API REST.
URL base
https://beepass.io/api/
Todas as rotas sao relativas a esta base. Por exemplo, a lista de rainhas F0 esta acessivel em GET https://beepass.io/api/queens/f0.
Autenticacao
Todas as rotas exigem uma sessao autenticada via Supabase Auth (cookies SSR). As rotas de administracao exigem adicionalmente um cookie HMAC beepass-admin-token.
Consulte a pagina Autenticacao para detalhes completos.
Formato
- Pedidos:
Content-Type: application/json - Respostas: JSON
- Codificacao: UTF-8
Paginacao
Os endpoints de listagem suportam paginacao via parametros de consulta:
| Parametro | Tipo | Predefinicao | Descricao |
|---|---|---|---|
limit | integer | 20 | Numero de itens por pagina (max 100) |
offset | integer | 0 | Numero de itens a ignorar |
Codigos de erro
| Codigo | Descricao |
|---|---|
400 | Bad Request — parametros invalidos ou corpo do pedido mal formado |
401 | Unauthorized — sessao em falta ou expirada |
403 | Forbidden — permissoes insuficientes (ex.: acesso de administrador necessario) |
404 | Not Found — recurso nao existe ou nao lhe pertence |
429 | Too Many Requests — limite excedido |
500 | Internal Server Error — erro do servidor |
Os erros devolvem um objeto JSON:
{
"error": "Descricao do problema"
}
Rate Limiting
Os limites de pedidos sao aplicados via Upstash Redis:
| Acao | Limite |
|---|---|
| Login | 10 tentativas / 15 minutos |
| Registo | 3 / hora |
| Envio de codigo de verificacao | 5 / 10 minutos |
| Verificacao de codigo | 10 / minuto |
RLS (Row Level Security)
Todos os dados sao restritos ao utilizador autenticado via owner_id = auth.uid(). So tem acesso as suas proprias rainhas, avaliacoes e resultados. Os dados de referencia (BeePass Index) sao apenas de leitura para todos os utilizadores autenticados.
Ver tambem: Autenticacao | Chaves API | Rainhas | Avaliacoes | EBV | Exportacao