Внимание: API находится в активной разработке. Вскоре он будет дополнен множеством новых методов, однако подлежит изменению в существующих методах . Мы сообщим вам о важных изменениях, оставайтесь на связи

Начало работы

В этом документе описывается интерфейс программирования службы WhoCPA (далее «API»). Через API внешние приложения добавляют и редактируют предложения, цели, рекламные материалы, получают списки предложений, потенциальных клиентов и все виды статистики.

Предполагается, что читатель знает терминологию и понимает принципы сетей CPA. Эта информация содержится в помощь пользователю.

Случаи использования

API предоставляет различные уровни доступа к системным объектам; эти уровни соответствуют типам счетов. Без авторизации доступен уровень «Гость», с помощью которого можно получить информацию, также доступную без регистрации на сайте: список доступных предложений, их цели, новости и т. Д. Уровни «Веб-мастер» и «Рекламодатель» соответствуют на функционал подобных аккаунтов на сайте.

Доступ

Публичная информация, такая как список предложений, их цели, категории и т. Д. Доступна без разрешения.

Чтобы использовать функциональность вашей учетной записи, с каждым запросом вы должны передавать параметр api_key , который можно получить на странице профиля или вверху этой страницы.

REST

API построен по принципу REST. Чтобы получить доступ к любому ресурсу, просто сделайте обычный HTTP-запрос.

В общем, URL ресурса выглядит так: /api/<resource_name>, Могут быть методы взаимодействия с ресурсом

Очевидно, что не каждый ресурс поддерживает все 5 методов взаимодействия. Полный список доступных методов для каждого типа учетной записи можно увидеть в меню «Ресурсы и методы» слева.

Параметры запроса

Используется базовый метод передачи данных по HTTP. В случае запросов GET & mdash; параметры передаются в виде строки параметров URL, в случае POST, PUT, DELETE & mdash; в теле запроса.

Дополнительная сериализация запроса не требуется, однако обратите внимание, что в некоторых случаях необходимо использоватьКодировка URL.

Ответы и ошибки сервера

Формат данных ответа - всегда json. В таблице выше вы можете увидеть, какие поля следует ожидать в ответе в случае успешного запроса. В случае ошибки в ответе будет стерто только поле error.

Общее правило таково: если в ответе отсутствует поле error , то запрос выполнен успешно, а в ответе нужно искать поле, соответствующее запросу (см. Таблицу методов) .

Поле error содержит наиболее подробное описание ошибки. Это поле может содержать строку или более сложную структуру данных, например:

GET /api/geo?api_key=wrongkey

{ "error": "Unauthorized" }

GET /api/goal/?offer_id=-123

{ "error": { "offer_id": ["Offers not found"] } }

Помимо описания ошибки в поле error , общая информация об ответе (включая ошибку) передается в коде состояния HTTP. Список используемых кодов: