Panoramica
L'API BeePass offre un accesso programmatico ai vostri dati di selezione: regine, valutazioni, valori genetici (EBV), pedigree ed esportazioni. Tutte le operazioni disponibili nell'interfaccia web sono accessibili tramite l'API REST.
Base URL
https://beepass.io/api/
Tutte le rotte sono relative a questa base. Ad esempio, l'elenco delle regine F0 è accessibile tramite GET https://beepass.io/api/queens/f0.
Autenticazione
Tutte le rotte richiedono una sessione autenticata tramite Supabase Auth (cookie SSR). Le rotte di amministrazione richiedono inoltre un cookie HMAC beepass-admin-token.
Consultate la pagina Autenticazione per tutti i dettagli.
Formato
- Richieste:
Content-Type: application/json - Risposte: JSON
- Codifica: UTF-8
Paginazione
Gli endpoint di elenco supportano la paginazione tramite parametri di query:
| Parametro | Tipo | Default | Descrizione |
|---|---|---|---|
limit | integer | 20 | Numero di elementi per pagina (max 100) |
offset | integer | 0 | Numero di elementi da saltare |
Codici di errore
| Codice | Descrizione |
|---|---|
400 | Bad Request — parametri non validi o corpo della richiesta malformato |
401 | Unauthorized — sessione mancante o scaduta |
403 | Forbidden — permessi insufficienti (es.: accesso admin richiesto) |
404 | Not Found — risorsa inesistente o non posseduta |
429 | Too Many Requests — limite di richieste superato |
500 | Internal Server Error — errore lato server |
Gli errori restituiscono un oggetto JSON:
{
"error": "Descrizione del problema"
}
Rate Limiting
I limiti di richieste sono applicati tramite Upstash Redis:
| Azione | Limite |
|---|---|
| Login | 10 tentativi / 15 minuti |
| Registrazione | 3 / ora |
| Invio codice di verifica | 5 / 10 minuti |
| Verifica codice | 10 / minuto |
RLS (Row Level Security)
Tutti i dati sono limitati all'utente autenticato tramite owner_id = auth.uid(). Potete accedere esclusivamente alle vostre regine, valutazioni e risultati. I dati di riferimento (indice BeePass) sono in sola lettura per tutti gli utenti autenticati.
Vedi anche: Autenticazione | Chiavi API | Regine | Valutazioni | EBV | Esportazione