API 2.0

Данный функционал предоставляется на тарифах линейки Pro.
Текущая версия API 2.0 доступна с ревизии 3.0.4.22693. Документация предыдущей версии API 1.0 доступна здесь.

API расширяет возможности использования системы. С помощью API компании "Клиентская База" можно подключить свой телеграм бот, настроить телефонию, сделать интеграцию с сайтом и многое другое.

Форматы запросов и ответов к API имеют кодировку UTF-8, соответствуют спецификации JSON и используют REST-архитектуру.

Методы

API включает следующие методы (в фигурных скобках находятся изменяемые значения):

Типы запросов

Методы используют типы запросов GET, POST и другие, которые имеют смысл в конкретном случае.
GET — Получить данные или список данных
POST — Добавить данные
PATCH — Изменить данные
DELETE — Удалить данные

Проверка работы API без аутентификации

Данный метод выводит приветствие с указанным текстом: "Hello, {Ваш-текст}!"

Запрос

GET {URL-аккаунта}/api/dev/hello/{Ваш-текст}

Замените {URL-аккаунта} на URL экземпляра КБ, например, https://demo.clientbase.ru или http://localhost:8080/.
Замените {Ваш-текст} на любой текст.

img-2025-07-16-10-57-56

Формат ответа

200 OK (application/vnd.api+json)
либо ошибка

Аутентификация

Для работы с API необходим API-токен, который будет передаваться в заголовке запроса.
Для получения API-токена перейдите в раздел Настройки -> Еще -> Управление API-токенами (API 2.0), выберите пользователя, задайте дату окончания действия ключа и нажмите «Добавить».

img-2025-06-25-10-02-49

Запросы выполняются с правами доступа пользователя, для которого создан токен. Рекомендуем выбрать пользователя из группы доступа «Администратор».

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

Готовая библиотека

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

Коды HTTP-ответов частых ошибок

400 — некорректный запрос (неверные параметры или не прошла валидация)
401 — ошибка авторизации
403 — доступ запрещён по правам
404 — объект не найден
405 — метод не разрешён для использования
426 — необходима докупка лицензий (доступ к модулям не входящим в лицензию)
429 — превышено число допустимых запросов (лимит частоты запросов)
443 — нет прав доступа к объекту 500 — неизвестная ошибка сервера (не обработанное исключение в коде сервера)
501 — метод ресурса не существует или не реализован