Перейти к содержимому
Филин Филин · Для разработчиков Бета

Проверка данных

Эндпоинт POST /v1/validate проверяет структуру и связность вашего payload и возвращает ошибки построчно, ничего не записывая. Прогоняйте его перед каждой боевой заливкой.

Бета. Контракт может меняться. Эндпоинт /validate открыт по тестовому ключу ещё до заключения договора - боевой приём и результаты открываются после подключения (оплаты).

Песочница по тестовому ключу

Проверить форму данных можно до заключения договора. По тестовому ключу открыт только POST /v1/validate: он проверяет структуру и связность payload и возвращает ошибки построчно, ничего не записывая в базу. Это позволяет вашим разработчикам убедиться, что интеграция ляжет, ещё на этапе переговоров.

Что проверяет валидатор

  • Обязательные поля каждой сущности присутствуют (см. Модель данных).
  • Форматы корректны: даты - ISO 8601 с таймзоной, type коммуникации - из известного набора.
  • Связность в пределах payload: коммуникация ссылается на существующую сделку и сотрудника, сделка - на существующие воронку, стадию и сотрудника.

Что возвращает

Тот же набор кодов, что и боевой приём (см. Коды ответов и ошибки):

  • 200 - payload корректен;
  • 207 - часть строк отклонена, в теле - список отклонённых с причинами построчно;
  • 400 / 422 - битый JSON или невалидное значение;
  • 409 - ссылка на несуществующую в payload сущность;
  • 401 - нет или неверный ключ.

Валидатор не пишет в базу - счётчики сущностей после запроса не меняются.

Дальше