Коды ошибок
Эта страница является единственным источником достоверной информации по обработке ошибок. Коды ошибок, специфичные для SDK, задокументированы на странице Обработка ошибок каждого SDK; данная страница охватывает ошибки на уровне API-контракта.
Коды состояния HTTP
| Код | Значение |
|---|---|
200 OK | Запрос выполнен успешно. |
400 Bad Request | Payload некорректен или отсутствуют обязательные поля. В теле ответа указаны проблемные поля. |
401 Unauthorized | Аутентификация отсутствует, просрочена или недействительна. |
403 Forbidden | Аутентификация действительна, но тенант не включён для запрошенного ресурса (например, вызов возможности, не входящей в ваш APIKEY). |
404 Not Found | Ресурс не существует или не принадлежит аутентифицированному тенанту. |
409 Conflict | Ресурс существует, но находится не в том состоянии для данной операции (например, получение документов из процесса, который ещё выполняется). |
410 Gone | Ресурс существовал, но был удалён согласно политике хранения (эндпоинты получения документов), либо процесс существует, но завершился с ошибкой — см. Получение процесса. |
429 Too Many Requests | Превышен лимит частоты запросов. Повторите попытку с экспоненциальной задержкой. |
5xx | Ошибка платформы. Повторите попытку с задержкой; если проблема не исчезает, обратитесь в поддержку с телом ответа и временной меткой. |
Политика повторных попыток
| Статус | Повторять? | Как |
|---|---|---|
5xx | Да | Экспоненциальная задержка (1 с, 2 с, 4 с, 8 с, …). Ограничьте 5 попытками. |
429 | Да | Соблюдайте заголовок Retry-After, если он присутствует; иначе используйте экспоненциальную задержку. |
4xx (другие) | Нет | Запрос некорректен. Исправьте входные данные перед повторной попыткой. |
401 | Условно | Обновите токен доступа один раз. Если новый запрос также возвращает 401, проблема структурная — не повторяйте попытку. |
Платформа IDCloud в настоящее время не предоставляет механизм ключа идемпотентности для эндпоинтов создания. Будьте осторожны при повторных попытках Создание процесса — сетевая ошибка при 5xx может означать, что операция фактически выполнилась на сервере, и повторная попытка создаст дублирующий процесс. В случае сомнений получите список последних процессов по вашему внутреннему correlation ID перед повторной попыткой.
Где находятся ошибки SDK
Каталоги ошибок Android SDK, iOS SDK и Flutter SDK задокументированы на специальной странице Обработка ошибок каждого SDK:
Они охватывают ошибки на стороне устройства (запрет доступа к камере, тайм-аут захвата, недоступность сети на устройстве) — в отличие от ошибок на стороне API, задокументированных здесь.