API.URI - уточняйте в тех.поддержке.

Запросы

1. Все запросы к АПИ выполняются в формате POST(HTTP)
2. URI запроса формируется по схеме API.URI + '/' + serviceName + '.' + methodName
3. Все параметры передаются в application/x-www-form-urlencoded
4. Все запросы должны быть подписаны с использованием Секретного ключа(если не указано обратное для конкретного метода)

• В подписи не участвуют параметры запроса, имена которых начинаются с partner.
• Допустимо передавать в параметрах различную мета информацию (с неопределенной целью). Для того, чтобы эти параметры не участвовали в подписи их имена должны начинаться с meta..
• Пример: рекомендуется, но не обязательно передавать параметр со случайной величиной, который в дальнейшем может ускорить поиск нужного запроса в логах( например: meta.id=random).

Ответы

1. Все ответы Платформа отдает в формате JSON.

   • Http Status Code - не является частью апи и во всех ответах должен быть 200 (в случае успешных и неуспешных вызовах). Http Status Code отличный от 200 говорит либо о серьезных неполадках на сервере, либо полностью ошибочном запросе. Сверьтесь с документацией или обратитесь в тех.поддержку.
   • Общая схема положительного ответа : Все положительные ответы должны в теле ответа содержать "status": 200

   {
         "status" : 200,
         "method" : "service.method",
         "response" : ...response entity as json...
   }
   

• Общая схема отрицательного ответа:

  {
        "status" : "цифровой код отличный от 200",
        "method" : "service.method",
        "message" : "Строковое описание ошибки. В целях безопасности, описание не обязательно четко описывает, что произошло на сервере, но в некоторых случаях может служить подсказкой. В остальных случаях обратитесь в тех.поддержку."
  }
  

Перечень параметров, которые передаются для всех методов:

• @partner.alias - Идентификатор партнера
• @partner.sign - Подпись сформированная с использованием параметров запроса и Секретного Ключа.

Во всех примерах ниже для формирования подписи использованы следующие параметры:

• Идентификатор Партнера = test
• Секретный ключ = testsecret

Формирование Подписи