К содержанию
БазаДокументация

API v1

Обзор и аутентификация

API v1 — публичный, stateless-интерфейс к данным рабочего пространства. Авторизация — персональный токен (Sanctum), привязанный к пространству.

API v1 — публичный, stateless-интерфейс к данным рабочего пространства. Авторизация — персональный токен (Sanctum), привязанный к пространству.

#Принципы

  • Версионирование — префиксом: /api/v1.
  • Токен в заголовке Authorization: Bearer <token>.
  • Каждый токен принадлежит одному рабочему пространству.
  • Ответы — JSON, идентификаторы — строки (UUID).
  • Значения полей записи — объект по идентификатору поля.
bash
curl https://ВАШ_ДОМЕН/api/v1/collections \
  -H "Authorization: Bearer ВАШ_ТОКЕН" \
  -H "Accept: application/json"

#Ошибки аутентификации

  • 401 — токен не передан или недействителен.
  • 403 — токену не хватает права (скоупа) для операции.

Безопасность

Передавайте токен только по HTTPS. Для проверки подписи входящих вебхуков используйте секрет вебхука, а не API-токен.