Übersicht
Die BeePass API bietet programmatischen Zugriff auf Ihre Zuchtdaten: Königinnen, Bewertungen, geschätzte Zuchtwerte (EBV), Stammbäume und Exporte. Alle in der Weboberfläche verfügbaren Operationen sind über die REST API zugänglich.
Base URL
https://beepass.io/api/
Alle Routen sind relativ zu dieser Basis. Die Liste der F0-Königinnen ist beispielsweise unter GET https://beepass.io/api/queens/f0 erreichbar.
Authentifizierung
Alle Routen erfordern eine authentifizierte Sitzung über Supabase Auth (SSR Cookies). Admin-Routen erfordern zusätzlich einen HMAC-Cookie beepass-admin-token.
Siehe die Seite Authentifizierung für vollständige Details.
Format
- Anfragen:
Content-Type: application/json - Antworten: JSON
- Kodierung: UTF-8
Paginierung
Listen-Endpoints unterstützen Paginierung über Query-Parameter:
| Parameter | Typ | Standard | Beschreibung |
|---|---|---|---|
limit | integer | 20 | Anzahl der Elemente pro Seite (max. 100) |
offset | integer | 0 | Anzahl der zu überspringenden Elemente |
Fehlercodes
| Code | Beschreibung |
|---|---|
400 | Bad Request — ungültige Parameter oder fehlerhafter Request-Body |
401 | Unauthorized — fehlende oder abgelaufene Sitzung |
403 | Forbidden — unzureichende Berechtigungen (z.B. Admin-Zugang erforderlich) |
404 | Not Found — Ressource existiert nicht oder gehört Ihnen nicht |
429 | Too Many Requests — Anfragelimit überschritten |
500 | Internal Server Error — serverseitiger Fehler |
Fehler liefern ein JSON-Objekt:
{
"error": "Beschreibung des Problems"
}
Rate Limiting
Anfragelimits werden über Upstash Redis durchgesetzt:
| Aktion | Limit |
|---|---|
| Login | 10 Versuche / 15 Minuten |
| Registrierung | 3 / Stunde |
| Verifizierungscode senden | 5 / 10 Minuten |
| Verifizierungscode prüfen | 10 / Minute |
RLS (Row Level Security)
Alle Daten sind auf den authentifizierten Benutzer über owner_id = auth.uid() beschränkt. Sie können nur auf Ihre eigenen Königinnen, Bewertungen und Ergebnisse zugreifen. Referenzdaten (BeePass Index) sind schreibgeschützt für alle authentifizierten Benutzer.
Siehe auch: Authentifizierung | API-Schlüssel | Königinnen | Bewertungen | EBV | Export