Инструменты страницы
Интерфейс REST
Обратная совместимость API не нарушается, если:
- появляется новый необязательный параметр в запросе;
- появляется новый параметр в ответе;
- меняется порядок параметров в ответе.
Взаимодействия реализуются как HTTP обращения методом POST на определенные URL, для каждого типа - свой. Параметры передаются как параметры POST запросов, значения должны быть совместимы с URL (т.е. url encoded).
Результат обработки запроса возвращается в виде JSON объекта. Например:
{"errorCode":"12","errorMessage":"Empty amount"}
Для авторизации обращения магазина к системе платежного шлюза, в любом запросе со стороны магазина должны быть приведены имя и пароль магазина, которые представитель магазина ввел при регистрации магазина в системе. Значения имени и пароля передаются в следующих параметрах:
Название | Тип | Обязательно | Описание |
---|---|---|---|
|
AN..30 | Да | Логин магазина, полученный при подключении |
|
AN..200 | Да | Пароль магазина, полученный при подключении |
В зависимости от выбранной схемы системы оплаты ( одно стадийная или двух стадийная) синтаксис запросов различается. Ниже описаны запросы для каждой из них.
Тип содержимого запроса должен быть application/x-www-form-urlencoded
.
Все текстовые поля должны иметь кодировку Юникод (UTF-8).
Специальные символы в REST-запросе должны быть экранированы с помощью URL-кодировки. Например, пароль qwe?rt%y
должен передаваться в виде qwe%0Frt%25y
. Дополнительную информацию об экранировании в запросах и таблицу символов см. по адресу https://wm-school.ru/html/html_url_acsii.html
Если errorCode
(Код ошибки) = 0, запрос был обработан Платежным шлюзом без системных ошибок (при этом errorCode
не показывает статус заказа).