Обращение к API

Обращение к API

Запросы

Формат URL для обращения к AdHub API:

http://www.adhub.ru/api/?apiKey=&apiAction=&format=&a=1&b=2&c=...

Запросы осуществляются методом $_GET.

Входящие значения:

  • apiAction: действие, которое необходимо выполнить
  • apiKey: ключ API, который предоставляется при обращении в службу поддержки
  • format: формат ответа сервера:
    • json для JSON (по-умолчанию, на момент тестирования единственный доступный формат)
  • прочие параметры зависят от конкретных действией.

Ответы

Возвращаемый массив данных всегда имеет один корневой элемент с именем result или error. Структура данных не зависит от формата. Используемая кодировка — UTF-8.

error означает, что произошла ошибка, и содержит два элемента: code и text — код и описание ошибки. Коды ошибок:

  • 100 Ошибка авторизации
  • 200 Неверное действие
  • 500 Внутренняя ошибка

Пример ошибки в формате JSON:

{ "error": { "code":100, "text":"Auth?" } }

result

result означает, что запрос выполнен успешно, и содержит возвращаемые данные.

8 декабря 2014 г.