Skip to main content

Форматы запроса

Для чтения используются и GET, и POST. Ориентируйтесь на описание метода. Например, POST /personnel/profile читает карточку, а PATCH /personnel/profile её изменяет. Для JSON указывайте Content-Type: application/json. Загрузка доказательства принимает байты PNG или JPEG в теле запроса. Чтение доказательства возвращает PNG. Для списков с курсором передавайте next_cursor в следующем запросе, сохраняя исходные фильтры. История изменений профиля использует offset и snapshot.

Изменения и повтор запроса

1

Прочитайте актуальные данные

У методов с подготовкой сначала запросите доступные варианты и revision. К примеру, подготовьте кадровое действие перед его выполнением.
2

Отправьте команду

Передайте ревизию в указанном у метода поле. Если требуется Idempotency-Key, создайте отдельный ключ для операции и сохраните его вместе с телом запроса.
3

Обработайте результат

При сетевом сбое повторите ту же операцию с тем же ключом и телом. При конфликте ревизии перечитайте данные и проверьте действие перед новой отправкой.

Формат ошибок

Ответы об ошибках содержат машинный code. Если в ответе есть correlation_id или заголовок X-Correlation-ID, сохраните его для диагностики.
Условный ответ HTTP 401
Актуальные лимиты разработчика, бота и операций можно прочитать через GET /me. Прокси может вернуть ошибку с телом другого формата. Обрабатывайте HTTP-статус до разбора JSON.