Appearance

Обзор API ​

📌 Краткий обзор

В данном разделе вы сможете быстро ознакомиться о основными принципами Kodzero API. Для полного описания обратитесь к разделу REST API

Kodzero автоматически генерирует REST API для каждой коллекции. Все запросы выполняются к базовому URL:

https://api.kodzero.pro/v1/:project/:collection

Где:

  • :project — идентификатор вашего проекта
  • :collection — идентификатор коллекции

Получить URL для коллекции можно во вкладке «Настройки API».

Методы для работы с коллекциями ​

View all ​

Полное описание:REST API → View All

Получение списка всех записей с поддержкой поиска, фильтрации и пагинации.

http
GET /v1/:project/:collection

Query-параметры:

ПараметрТипОписание
searchstringПоиск по текстовым полям
pagenumberНомер страницы (по умолчанию: 1)
perPagenumberЗаписей на странице (по умолчанию: 25)

Пример запроса:

http
GET https://api.kodzero.pro/v1/12345/100069?search=phone&perPage=10

View ​

Полное описание:REST API → View

Получение одной записи по ID.

http
GET /v1/:project/:collection/:id

Пример запроса:

http
GET https://api.kodzero.pro/v1/12345/100069/694d2de72f69bc65a83c42ce

Create ​

Полное описание:REST API → Create

Создание новой записи.

http
POST /v1/:project/:collection

Пример запроса:

http
POST https://api.kodzero.pro/v1/12345/100069
Content-Type: application/json

{
  "title": "Футболка",
  "price": 1499.99
}

Валидация

Данные в теле запроса проходят валидацию в соответствии с настройками схемы коллекции (типы полей, обязательность, ограничения).

Update ​

Полное описание:REST API → Update

Изменение существующей записи по ID.

http
PATCH /v1/:project/:collection/:id

Пример запроса:

http
PATCH https://api.kodzero.pro/v1/12345/100069/694d2de72f69bc65a83c42ce
Content-Type: application/json

{
  "price": 899
}

Валидация

Передаваемые поля проходят валидацию в соответствии с настройками схемы коллекции. При это обновлять можно только часть полей.

Delete ​

Полное описание:REST API → Delete

Удаление записи по ID.

http
DELETE /v1/:project/:collection/:id

Пример запроса:

http
DELETE https://api.kodzero.pro/v1/12345/100069/694d2de72f69bc65a83c42ce

Методы в разработке ​

Следующие методы находятся в стадии разработки или тестирования, но скоро станут доступны.

Distinct ​

Получение уникальных значений указанного поля. Полезно для построения фильтров (например, список всех категорий или брендов).

Экспорт в CSV/XLSX ​

Экспорт данных коллекции в файлы CSV или XLSX для аналитики или резервного копирования.

Batch-операции ​

Массовые операции: создание, обновление или удаление нескольких записей одним запросом.

🚀 Нужен один из этих методов?

Если ваш проект требует функциональности из этого раздела — напишите в поддержку (team@kodzero.pro), и мы постараемся приоритизировать разработку.

Уровни доступа ​

Для всей коллекции и для каждого метода можно настроить уровень доступа:

УровеньОписание
PublicЗапросы без авторизации. Подходит для публичных данных (каталоги, статьи)
UserПользователь видит и изменяет только свои записи
WorkspaceПользователь работает с записями в рамках общего пространства, к которому принадлежит

⚠️ Важно!

Для публичных данных используйте Public только на методах VIEW ALL и VIEW. Методы CREATE, UPDATE, DELETE лучше защитить уровнем User или Workspace.

test