Обзор
API BeePass обеспечивает программный доступ к вашим данным по разведению: маткам, оценкам, расчётным племенным ценностям (EBV), родословным и экспорту. Все операции, доступные в веб-интерфейсе, также доступны через REST API.
Базовый URL
https://beepass.io/api/
Все маршруты указываются относительно данного адреса. Например, список маток F0 доступен по адресу GET https://beepass.io/api/queens/f0.
Аутентификация
Все маршруты требуют аутентифицированной сессии через Supabase Auth (SSR cookies). Маршруты администратора дополнительно требуют HMAC-cookie beepass-admin-token.
Подробности см. на странице Аутентификация.
Формат
- Запросы:
Content-Type: application/json - Ответы: JSON
- Кодировка: UTF-8
Пагинация
Конечные точки списков поддерживают пагинацию через параметры запроса:
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
limit | integer | 20 | Количество элементов на странице (макс. 100) |
offset | integer | 0 | Количество пропускаемых элементов |
Коды ошибок
| Код | Описание |
|---|---|
400 | Bad Request — некорректные параметры или неверный формат тела запроса |
401 | Unauthorized — отсутствующая или просроченная сессия |
403 | Forbidden — недостаточно прав (например, требуется доступ администратора) |
404 | Not Found — ресурс не существует или не принадлежит вам |
429 | Too Many Requests — превышен лимит запросов |
500 | Internal Server Error — ошибка на стороне сервера |
Ошибки возвращают JSON-объект:
{
"error": "Описание проблемы"
}
Ограничение частоты запросов
Лимиты запросов контролируются через Upstash Redis:
| Действие | Лимит |
|---|---|
| Вход | 10 попыток / 15 минут |
| Регистрация | 3 / час |
| Отправка кода подтверждения | 5 / 10 минут |
| Проверка кода подтверждения | 10 / минута |
RLS (Row Level Security)
Все данные ограничены аутентифицированным пользователем через owner_id = auth.uid(). Вы можете получить доступ только к своим маткам, оценкам и результатам. Справочные данные (BeePass Index) доступны для чтения всем аутентифицированным пользователям.
См. также: Аутентификация | API-ключи | Матки | Оценки | EBV | Экспорт