Описание API и протокола взаимодействия
Протокол запросов/ответов
Все запросы к сайту осуществляются посредством POST запросов на адрес https://ad-core.ru/api.php
В каждом запросе должен обязательно присутствовать ключ apiKey, также указывается метод method, остальные параметры указываются в зависимости от метода.
Все ответы возвращаются в виде JSON строки, с параметрами status (варианты 0 в случае ошибки и 1 в случае успеха) и msg(сообщение о результате в виде текста).
Уведомления
Если Вам необходимы уведомления о различных событиях(например окончание компании) то в Настройках укажите URL адрес сайта и сохраните изменения, все уведомления приходят в виде POST запроса на указанный URL.
Формат уведомления:
| Параметр |
Значение |
Описание |
| typ |
endAds |
окончание компании |
| id |
N |
идентификатор компании |
Получение ключа
Для каждого пользователя существует свой уникальный ключ для доступа к API, чтобы его получить перейдите в раздел настроек по этой ссылке Настройки и поставьте галочку напротив пункта "Включить API" и сохраните изменения.
Пример реализации на языке php доступен по ссылке Скачать
Примеры запросов
Получение рекламного баланса
Запрос:
| Параметр |
Значение |
Описание |
| method |
getMoney |
название метода |
Ответ в случае успеха:
| Поле |
Описание |
| money |
значение баланса |
Создание рекламной компании
Запрос:
| Параметр |
Значение |
Описание |
| method |
ads |
название метода |
| action |
add |
действие - добавление |
| typ |
Код вида рекламы* |
подробные коды см. ниже |
| url |
адрес ссылки |
полный адрес c http... |
| cnt |
число исполнителей |
кол-во исполнителей, минимум 20. |
| title |
заголовок |
название компании (не обязательно) |
| user_price |
цена |
цена за одно выполнение (в некоторых компаниях обязательное поле, где-то нет) |
| is_traf |
1 |
давать задание только для проверенных(цена в 2 раза выше) (не обязательно) |
| per_day |
0 |
примерное распределение исполнителей в сутки, там где это доступно (не обязательно).
0 - безлимит. |
Коды рекламных компаний:
0 - серфинг, 1 - письма, 2 - YT видео, 3 - YT подписки, 4 - YT лайки, 5 - YT дизлайки, 7 - VK репост, 8 - VK подписки в группу, 14 - VK лайки, 17 - VK друзья, 18 - Instagram друзья, 19 - Instagram лайки.
Ответ в случае успеха:
| Поле |
Описание |
| id |
идентификатор рекламной компании |
Получение статуса рекламной компании
Запрос:
| Параметр |
Значение |
Описание |
| method |
getStatus |
название метода |
| id |
N |
идентификатор компании |
Ответ в случае успеха:
| Поле |
Описание |
| adsStatus |
статус рекламы (0 - остановлено, 1 - активно) |
Изменение статуса рекламной компании
Запрос:
| Параметр |
Значение |
Описание |
| method |
setStatus |
название метода |
| id |
N |
идентификатор компании |
| status |
число |
значение статуса (0 - пауза, 1 - старт) |
Ответ в случае успеха:
| Поле |
Описание |
| adsStatus |
новый статус рекламы (0 - остановлено, 1 - активно) |
Пополнение счета рекламной компании
Запрос:
| Параметр |
Значение |
Описание |
| method |
addMoney |
название метода |
| id |
N |
идентификатор компании |
| money |
число |
сумма перевода |
Ответ в случае успеха:
Получение статистики рекламной компании
Запрос:
| Параметр |
Значение |
Описание |
| method |
stats |
название метода |
| id |
N |
идентификатор компании |
Ответ в случае успеха:
| Поле |
Описание |
| data |
массив содержащий дни в формате Y-m-d и кол-во исполнителей |
Стоит обратить внимание, что статистика "живет" 7 дней с момента последнего выполения этого задания.