3.6. Коды статусов HTTP

Ниже приведены коды ответов HTTP для различных методов HTTP всех конечных точек API.

Ситуация

HTTP статус

Комментарий

Для POST

Для GET

Для DELETE

Для PUT

Запрос успешно выполнен

200 OK

нет

да

нет

да

Операция создания выполнена успешно

201 Created

Результатом операции является создание нового ресурса

да

нет

нет

нет

Операция удаления успешно завершена

204 No Content

нет

нет

да

нет

Запрос имеет неверные отсутствующее или несовместимое тело JSON, параметры URL или поля заголовка

400 Bad Request

Запрошенная операция не будет выполнена

да

да

да

да

Заголовок авторизации отсутствует или неверный токен

401 Unauthorized

Операции было отказано в доступе.

да

да

да

да

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

Токен имеет неверную область действия или была нарушена политика безопасности

403 Forbidden

Операции было отказано в доступе.

да

да

да

да

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

1. Сторонний Поставщик пытается получить ресурс, который указан в спецификации, но не реализован на стороне ППУ (например, ППУ решил не реализовывать конечную точку API статуса для внутренних запланированных платежей).

404 (Not Found)

да

да

да

да

2. Сторонний Поставщик пытается получить ресурс, который не определен

Сторонний Поставщик попытался получить доступ к ресурсу с помощью метода, который не поддерживается

405 Method Not Allowed

да

да

да

да

Запрос содержал параметр заголовка Accept, отличный от разрешенных media types, и набор символов, отличный от UTF-8

406 Not Acceptable

да

да

да

да

Операция была отклонена, поскольку полезная нагрузка находится в формате, не поддерживаемом этим методом на целевом ресурсе

415 Unsupported Media Type

да

нет

нет

да

Операция была отклонена, так как слишком много запросов было сделано в течение определенного периода времени

429 Too Many Requests

ППУ ограничивают запросы, если они сделаны сверх их политики добросовестного использования.

да

да

да

да

ППУ документируют свои политики добросовестного использования на своих порталах для разработчиков.

ППУ отвечают этим статусом, если количество запросов в единицу времени было превышено.

ППУ следует включать заголовок Retry-After в ответ, указывающий, как долго Сторонний Поставщик ожидает перед повторением операции

Что-то пошло не так на стороне ППУ

500 Internal Server Error

Операция не удалась

да

да

да

да

Устаревшая версия сервиса

503 Service Unavailable

Если API устарел и больше не поддерживается ППУ, его путь URI все еще может быть активным и принимать запросы. В этом контексте рекомендуется вернуть 503 Service Unavailable, чтобы TPP знал, что версия API находится в offline режиме

да

да

да

да