API 2.0

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

API 2.0 входит в тарифы не ниже линейки Pro.

Форматы запросов и ответов к 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

Внимание! По API можно просматривать данные, у которых стоит галочка "Экспорт". По API можно добавлять/редактировать данные, у которых стоит галочка "Импорт".

Методы

1. data

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

/data{table_id}

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

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

data - Работа с отдельными записями в таблице

/data{table_id}/{ID}

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

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

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

2. table

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

/table

GET - получение информации о структуре пользовательских таблиц, о правах доступа к таблице.

table - Работа с конкретной таблицей

/table/{ID}

GET - получение информации о структуре конкретной таблице, правах доступа к этой таблице.

3. user

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

/user

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

user - Работа с конкретным пользователем

GET - получение информации о пользователе с идентификатором ID

/user/{ID}

4. group

group - Работа с группами пользователей

/group

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

group - Работа с конкретной группой пользователей

/group/{ID}

GET - получение информации о группе пользователей с идентификатором ID

5. file

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

/file/{table_id}/{field_id}/{line_id}/?filename={filename}

GET - получение информации о файле, хранящемся в поле пользовательской таблицы

6. hello

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

/hello/{name}

GET - вывод приветствия для указанного имени: "Hello, {name}!"

image: mail