Все интерфейсы активируются только по запросу.

Каждый запрос к интерфейсу должен быть подписан с использованием ключа для подписи запросов (задается в настройках API). Подпись формируется путем склеивания через два двоеточия всех значений передаваемых обязательных параметров и вычисления хэша получившейся строки по алгоритму MD5. Алгоритм склеивания значений параметров, участвующих в формировании подписи, следующий:

  • сначала склеиваются значения параметров Api и Timestamp;
  • полученная строка склеивается с ключом для подписи запросов Key;
  • затем к получившемуся результату в алфавитном порядке приклеиваются значения остальных параметров, требующихся интерфейсу, кроме параметров вида UserData[DataKey];
  • если интерфейс принимает дополнительные данные с помощью параметров вида UserData[DataKey], то они склеиваются в алфавитном порядке (с сортировкой по ключу DataKey) и через два двоеточия присоединяются в самый конец получившейся на предыдущем шаге строки;
  • вычисляется MD5-хеш полученной строки, который при обращении к интерфейсу нужно передавать в параметре Sig.

В случае успешной обработки запроса интерфейсы возвращают результат с HTTP-кодом 200: объект ApiResult в формате JSON или XML (в зависимости от HTTP-заголовка Accept в запросе). При возникновении ошибок интерфейсы вернут результат с HTTP-кодом, отличным от 200: объект Error, содержащий в поле Message краткое описани ошибки. Для переопределения формата ответа допустимо добавить к запросу параметр format со значениями json или xml.

Список доступных интерфейсов

Примеры использования интерфейсов