Вступление

Коллекция Postman

Для изучения возможностей API можно воспользоваться коллекцией Postman.
В ней собраны все возможные API запросы с примерами передаваемых данных, для работы достаточно загрузить коллекцию и указать свой API key в переменных проекта.

Официальный сайт postman
Скачать коллекцию postman

Аутентификация

Используйте ключ API в качестве значения параметра key.

Для POST запросов API ключ можно передавать как POST параметром, так и GET параметром.
Для остальных видов HTTP-запросов API ключ должен передаваться GET параметром.

Получить/изменить ключ можно в настройках.

Параметры запроса

Для отправки запросов используйте HTTP-методы POST/GET.

Информация о формате тела ответа:
success - флаг, оповещает об успешности запроса
data - содержит результат запроса, либо сообщение об ошибке

Успешный запрос:

{
    "success": true,
    "data": {
        "field": "value"
    }
}

Запрос с ошибкой:

{
    "success": false,
    "data": {
        "name": "Unauthorized",
        "message" : "Your request was made with invalid credentials",
        "code": 0,
        "status": 401
    }
}

* Параметр message может быть не задан

Запрос с типизированной ошибкой:

{
    "success": false,
    "data": {
        "name": "Bad Request",
        "message": "Данный заказ не поддерживает отмену по кнопке",
        "code": 0,
        "status": 400,
        "error_id": "ORDER_CANCEL_NOT_SUPPORTED"
    }
}

* Ошибки с "status": 400 могут обладать уникальными идентификаторами error_id, на основе которых можно гибче писать логику своих приложений. Текст сообщения может со временем изменится, идентификатор - нет.

Формат ответа:

Ответ доступен в двух форматах: JSON, XML. Формат зависит от значения заголовка Accept:

Accept: application/json
Accept: application/xml

Чтобы установить формат вне зависимости от заголовка - передайте значение json или xml в GET-параметре _format.

Вступление Заказы Услуги Пользователь