Перейти к основному содержимому

Обзор

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

Пагинация

Конечные точки списков поддерживают пагинацию через параметры запроса:

ПараметрТипПо умолчаниюОписание
limitinteger20Количество элементов на странице (макс. 100)
offsetinteger0Количество пропускаемых элементов

Коды ошибок

КодОписание
400Bad Request — некорректные параметры или неверный формат тела запроса
401Unauthorized — отсутствующая или просроченная сессия
403Forbidden — недостаточно прав (например, требуется доступ администратора)
404Not Found — ресурс не существует или не принадлежит вам
429Too Many Requests — превышен лимит запросов
500Internal Server Error — ошибка на стороне сервера

Ошибки возвращают JSON-объект:

{
"error": "Описание проблемы"
}

Ограничение частоты запросов

Лимиты запросов контролируются через Upstash Redis:

ДействиеЛимит
Вход10 попыток / 15 минут
Регистрация3 / час
Отправка кода подтверждения5 / 10 минут
Проверка кода подтверждения10 / минута

RLS (Row Level Security)

Все данные ограничены аутентифицированным пользователем через owner_id = auth.uid(). Вы можете получить доступ только к своим маткам, оценкам и результатам. Справочные данные (BeePass Index) доступны для чтения всем аутентифицированным пользователям.


См. также: Аутентификация | API-ключи | Матки | Оценки | EBV | Экспорт