REST API
Kodzero автоматически генерирует REST API для каждой коллекции.
Базовый URL
Все запросы выполняются к базовому URL:
https://api.kodzero.pro/v1/:project/:collection| Параметр | Описание |
|---|---|
:project | Идентификатор вашего проекта |
:collection | Идентификатор коллекции |
💡 Подсказка
Получить готовый URL можно в разделе «Настройки API» коллекции.
Формат данных
- Запросы:
Content-Type: application/json - Ответы: JSON
Авторизация
Для защищённых методов (scope: User или Workspace) требуется токен авторизации:
http
Authorization: Bearer <token>Токен получается при аутентификации пользователя.
Методы
| Метод | Эндпоинт | Описание |
|---|---|---|
| View All | GET / | Список записей с фильтрацией и пагинацией |
| View | GET /:id | Получение записи по ID |
| Create | POST / | Создание записи |
| Update | PATCH /:id | Обновление записи по ID |
| Delete | DELETE /:id | Удаление записи по ID |
Формат ответа
Все ответы имеют единую структуру:
json
{
"ok": true,
"result": { ... }
}При ошибке:
json
{
"ok": false,
"error": "<string>"
}Подробнее об ошибках см. Коды ошибок.