Коды ответов и ошибки
Бета. Контракт может меняться. Доступ к боевому API открывается после подключения (оплаты).
Коды ответов
| Код | Когда | Что делать |
|---|---|---|
200 |
приём или чтение прошли | - |
207 |
часть строк батча принята, часть отклонена | в теле - список отклонённых с причинами построчно; исправить и переслать только их |
400 |
битый JSON или нет обязательного поля | исправить payload |
401 |
нет или неверный ключ | проверить Authorization |
409 |
конфликт ссылок (коммуникация ссылается на несуществующую сделку или сотрудника) | сначала залить родительские сущности, затем дочерние |
413 |
батч больше лимита | разбить на части (см. Батчи и идемпотентность) |
422 |
поле есть, но невалидно (формат даты, неизвестный type) |
исправить значение |
429 |
слишком часто | притормозить, повтор по Retry-After |
Как обрабатывать
- Дубль по
external_id- не ошибка, а upsert (обновление, не дубль), вернётся200. Подробнее - Батчи и идемпотентность. - Порядок заливки во избежание
409: сначалаemployeesиpipelines, затемdeals, затемcommunications,notes,attachments. - Всегда прогоняйте
POST /v1/validateперед боевой заливкой - он вернёт те же ошибки построчно, но ничего не записав (см. Проверка данных). - Частичный приём (
207). Батч принимается построчно: валидные строки записываются, отклонённые возвращаются со своими причинами - исправьте и перешлите только их.
Дальше
- Проверка данных - те же ошибки без записи в базу.
- Батчи и идемпотентность - лимиты и порядок.