API 2.0

Общая информация

Внимание! На данный момент API 2.0 выпущено в режиме альфа, дорабатывается и имеет возможность свободного использования и получения токенов. После выпуска стабильной ревизии API 2.0 возможность его использования останется только у соответствующих тарифов.

Форматы запросов и ответов к API соответствуют спецификации JSON API.

Точка входа: {site}/api/dev

Для выполнения запросов требуется передавать аутентификационный токен в http-заголовке X-Auth-Token. Токены формируются в разделе настроек "Управление API-токенами" ("Настройки" - "Еще" - "Управление API-токенами").

img-2023-09-26-14-11-23

Работа с API регулируется правами доступа пользователя, для которого создан токен.

Для удобной работы с API вы можете воспользваться готовой библиотекой на PHP https://github.com/clientbase-doc/api

Методы

  1. data - Работа с данными в таблицах

/data{table_id}

GET - получение списка записей

POST - создание новой записи

/data{table_id}/{ID}

GET - получение конкретной записи

PATCH - обновление конкретной записи

DELETE - удаление конкретной записи

  1. table - Работа с таблицами

/table - получение информации о структуре таблиц, о правах доступа

/table/{ID} - получение информации о пользовательской таблице с указанным ID

  1. user - Работа с пользователями

/user - получение информации о пользователях

/user/{ID} - получение информации о конкретном пользователе

  1. group - Работа с группами

/group - получение информации о группах пользователей

/group/{ID} - получение информации о конкретной группе пользователей

5. file - Работа с файлами

6. hello - Тестовый сервис приветствия