Документация
API
Формат запросов, ответов и справочник полей для интеграций.
Клиенты
Справочник описывает клиентов текущей организации. Список и получение одной карточки возвращают разный набор стандартных полей; кастомные поля приходят в customFields.
URL клиентов
Для клиентов используется общий API данных с именем раздела clients. Удаление клиентов через этот API недоступно.
| Метод | URL | Описание |
|---|---|---|
GET | /api/?mod=data&data=clients | Получить список клиентов текущей организации. |
GET | /api/?mod=data&data=clients&id=ID | Получить одну карточку клиента по id. |
POST | /api/?mod=save_data&data=clients | Создать нового клиента или сохранить существующего. Для обновления передайте id в теле запроса. |
| Поле | Тип | Обязательное | Default | Значения | Сохранение | Список | Карточка | Описание |
|---|---|---|---|---|---|---|---|---|
phone | phone | Да | Нет | Любое | Телефон клиента. Перед сохранением нормализуется сервером. | |||
name | string | Да | Нет | Любое | Имя клиента. | |||
id | number | Нет | Нет | Любое | Идентификатор существующего клиента. При создании не передается. | |||
comment | string | Нет | Нет | Любое | Внутренний комментарий к клиенту. | |||
photo | image | Нет | Нет | Любое | Подготовленное фото клиента. | |||
photo_original | image | Нет | Нет | Любое | Исходное изображение для фото клиента. | |||
photo_settings | json | Нет | Нет | Любое | Настройки кадрирования фото клиента. | |||
phone_formatted | string | Нет | auto | Любое | Телефон клиента в международном формате для отображения. Заполняется сервером. | |||
customFields | object | Нет | Нет | Любое | Значения кастомных полей по uid. Для сохранения используйте поле custom_fields в теле запроса. |
Ответы с ошибками
Если запрос не выполнен, API возвращает ok=false и числовой code. Подробности по полям передаются в errors[].type.
| Код | Когда возникает | Ответ |
|---|---|---|
16 | Не переданы обязательные phone или name, либо обязательные кастомные поля клиента. | required со списком незаполненных полей. |
17 | Поля клиента переданы, но не прошли проверку телефона или изображения. | errors со списком ошибок полей. |
11-14 | Нет доступа к клиенту, созданию, сохранению или превышен лимит тарифа. | message с причиной отказа. |
18 | Удаление клиента через этот API недоступно. | message с причиной отказа. |
| Тип ошибки | Поле | Когда возникает |
|---|---|---|
phone_error | phone | Телефон должен быть передан в корректном формате. |
phone_already_exists | phone | Клиент с таким телефоном уже есть в текущей организации. |
image_error | photo, photo_original | Изображение передано в неподдерживаемом формате или не прошло обработку. |