Преимущества Click API

Click API позволяет вести трафик напрямую на сайт вашего рекламодателя без лишних редиректов. В результате целевые страницы для пользователя загружаются быстрее. Также Click API позволяет указывать прямые ссылки на сайт рекламодателей в рекламных материалах.

Как использовать Click API?

Не все оффера поддерживают работу по Click API.
Если для оффера подключен данный вариант работы, то в карточке кампании будет присутствовать специальная иконка "Click API".



Общая схема работы Click API

Веб-мастер должен сделать запрос на URL Click API, запрос вернет click_id.
Click_id нужно подставить в прямую ссылку на сайт рекламодателя (URL адрес для трафика).



Пример ссылки Click API URL: https://tracker.hoqu.com/api/click/create?secure_key=4497bf7b-7956-4f31-8d70-2e72cfc07572&offer_id=5306&campaign_id=816&promo_id=522&user_useragent=123&user_ip=0.0.0.0

Пример ответа от сервера:

{
"data": {
"click_id": "be4991fe-ea59-5a5e-9931-6240eb0c8775",
"params": {
"click_id": "be4991fe-ea59-5a5e-9931-6240eb0c8775"
},
"exists": true,
"session_id": "f5f55912-4007-5861-85e2-5b6a6e9c3941"
},
"status": "success"
}


Значение be4991fe-ea59-5a5e-9931-6240eb0c8775 - это сlick_id.

Далее полученное значение подставьте в ссылку в поле “URL адрес для трафика” вместо {click_id}.
Пример ссылки: https://advertisers-web-site.com/?click_id=be4991fe-ea59-5a5e-9931-6240eb0c8775

ВАЖНО! Значение сlick_id, полученное в результате запроса на Сlick API URL, обязательно подставляйте в URL адрес для трафика. В противном случае конверсии не будут зафиксированы в HOQU.

В запросе на Click API URL необходимо передать следующие обязательные параметры:

secure_key - секретный ключ. Пример: 00000000-0000-0000-0000-000000000000.
offer_id - ID оффера. Пример: 123.
campaign_id - ID кампании. Пример: 456.
promo_id - ID промоматериала. Пример: 789.
user_ip - IP пользователя. Пример: 0.0.0.0.
user_useragent - user_useragent. Пример: Mazila Chrome\\/7.7.7.

Также в запросе Click API URL можно передать следующие необязательные параметры:

user_referrer - URL-адрес источника перехода пользователя. Пример: https://www.google.com/.
utm_source - источник трафика. Пример: yandex_direct.
subid1, subid2, subid3 - Пользовательские параметры.

Ответы сервера

200 - Успешно
{
"status": "success",
"code": 200
}

202 - Оффер неактивный
{
"reason": "offer_inactive",
"status": "trafficback",
"code": 202
}

202 - Кампания неактивна
{
"reason": "campaign_inactive",
"status": "trafficback",
"code": 202
}

202 - Таргетинг: IP-адрес или устройство пользователя не соответствуют условиям таргетинга оффера. В этом случае необходимо направить трафик на TrafficBack URL.
{
"reason": "targeting",
"status": "trafficback",
"code": 202
}

202 - Превышение лимитов: достигнут лимит конверсий по офферу.
{
"reason": "overcap",
"status": "trafficback",
"code": 202
}

400 - Значение в поле request.offer_id невалидно: значение полей offer_id, campaign_id, promo_id указано неверно.
{
"message": "Field request.offer_id is not valid",
"status": "error",
"code": 400
}

403 - В доступе отказано
{
"message": "Access denied",
"status": "error",
"code": 403
}

403 - Click API неактивно для данного оффера
{
"message": "Click api disabled for this offer",
"status": "error",
"code": 403
}

500 - Внутренняя ошибка сервера
{
"message": "Something bad happened on the server side, administration notified",
"status": "error",
"code": 500
}


Пример кода:
$curl = curl_init();
curl_setopt_array($curl, array(
> 'https://tracker.domain/api/click/create?secure_key=00000000-0000-0000-0000-000000000000&offer_id=123&campaign_id=456&promo_id=789&user_ip=0.0.0.0&user_useragent=Mazila%20Chrome/7.7.7&user_referrer=https://vk.com&utm_source=&utm_medium=&utm_campaign=&utm_term=&utm_content=&subid1=&subid2=&subid3=&subid4=&subid5=&subid6=',
> true,
> 'GET',
));
$response = curl_exec($curl);
curl_close($curl);
echo json_decode($response);
>


Дополнительно

Запросы URL Click API кэшируются в рамках одного оффера на 300 секунд для одного IP и user_agent в рамках одной кампании.
Была ли эта статья полезна?
Отменить
Спасибо!