Для начала работы с сервисом необходимо получить у куратора:
- key - ключ доступа, который должен присутствовать в каждом запросе, иначе в доступе будет отказано.
- shop_api_key - ключ, необходимый для формирования параметра "signature" при оплате
- shop_secret_key - ключ, необходимый для формирования параметра "signature" при оплате
- api_url - url для доступа к API.
Запросы к сервису посылаются методом GET. Обязательным параметром каждого запроса является «key», остальные параметры зависят от вызываемого метода.
|
Название |
Тип |
Длина/Формат |
Назначение |
|---|---|---|---|
| key | string | 36 | Ключ доступа |
Необязательный параметр «lang» отвечает за язык ответа на запрос и может принимать значения:
- ru – русский
- en – английский
Языком по умолчанию является русский, он используется в случае отсутствия в запросе параметра «lang».
Сервис может возвращает ответ в виде JSON сообщений.
В ссылке необходимо указывать формат ответа.
Например, запрос api_url/service/method.json?param1=value1&… вернет ответ в формате JSON.
Все другие форматы ответа, включая XML, больше не поддерживаются.
Общий вид ответа на любой запрос в формате JSON
{
"response" :
{
"result" :
{
"code" : 0,
"description" : "Успешное выполнение",
"execution_time" : 6.4469
},
"data" :
{
...
}
}
}
Значение тегов и атрибутов
|
Имя тега |
Имя атрибута |
Значение |
|---|---|---|
| result | code | Код ответа |
| result | description | Описание ответа |
| result | execution_time | Время выполнения запроса в секундах |