RU EN

# Click API Client

Обратите внимание!

Доступно только в профессиональной и бизнес редакции

Click API — интерфейс для удаленной работы с кампаниями трекера. Позволяет осуществлять запросы и получать ответы от трекера на внешних сайтах.

# Чем отличается от KClient.php

KClient.php - это готовый клиент (скрипт интеграции), который собран на основе Click Api V3. В нем уже собраны основные методы работы Click Api v3, а также автоматический проброс клика и интерпретация ответа трекера. Более подробно о клиенте читайте в разделе KClient.php

# Запросы к Click API Client

При запросе к API необходимо передавать «token» кампании: который можно взять в меню редактирования кампании в строке "Click API Токен", а также использовать правильный префикс доступа к клиенту:

/click_api/v3/

Пример запроса и ответа

curl "http://domain_tracker/click_api/v3?token=ebd928ea&log=1&info=1"

{
    "body": null,
    "contentType": "text/html; charset=utf-8",
    "headers": [
        "Location: http://domain.com/?data=&utm-campaign=aff1"
    ],
    "info": {
        "campaign_id": 2,
        "stream_id": 1117,
        "sub_id": "o2q6e42hs08jq",
        "type": "location",
        "url": "http://domain.com/?data=$keyword&utm-campaign=aff1"
    },
    "log": [
        "Processing campaign 2",
        "Referrer: ",
        "Source: ",
        "Keyword: ",
        "IP: 127.0.0.1",
        "UserAgent: HTTPie/0.6.0",
        "Language: ",
        "Is unique in campaign: no",
        "Checking stream #1282",
        "Filter  \"uniqueness\": allow",
        "Filter \"uniqueness\": rejected",
        "Checking stream #1343",
        "Filter \"region\": rejected",
        "Checking stream #1355",
        "Filter  \"limit\": allow",
        "Filter \"ip\": rejected",
        "Checking stream #1117",
        "Accepted by filters",
        "Stream #1117",
        "Send headers: Location: http://domain.com/?data=&utm-campaign=aff1",
        "[Profiler] 0.101 sec.  1 sql queries, 9MB (+7MB)"
    ],
    "uniqueness_cookie": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjoie1wic3RyZWFtc1wiOntcIjExMTdcIjoxNDkwNzA1MTQyfSxcImNhbXBhaWduc1wiOntcIjJcIjoxNDkwNzA1MTQyfSxcInRpbWVcIjoxNDkwNzA1MTQyfSJ9._u5H9oOOdyp02VTnDN8VG47oLDoqRHHKyYI3ChxRqw8"
}

# Параметры

Специальные параметры для Click API:

  • ip;
  • user_agent;
  • language;
  • landing_id;
  • uniqueness_cookie — текущее содержимое cookie;
  • log — нужен ли лог обработки клика (1 или 0);
  • info — получить блок info (1 или 0);
  • force_redirect_offer — выполнить действие оффера, иначе вернется только info.token. Также можно использовать параметры для кампаний.

# Ответ

Ответ возвращается в формате JSON. Его атрибуты:

Атрибут Тип Описание
headers array Массив header ответов
body string Тело ответа (например, текст страницы)
contentType string Тип ответа (в случае с json, будет «application/json; charset=utf-8»)
uniqueness_cookie string Cookie, которое необходимо отправлять в дальнейших запросах к KClient PHP.
log array Содержимое лога обработки клика
cookies_ttl int Количество часов, на протяжении которых нужно хранить куки на стороне сайта
info object Контейнер с информацией по клику
info.sub_id string
info.campaign_id int
info.stream_id int
info.landing_id int
info.offer_id array
info.token string
info.uniqueness array
info.uniqueness.campaign boolean
info.uniqueness.stream boolean
info.uniqueness.global boolean
info.is_bot boolean

# Как отправить на оффер?

Сформируйте ссылку формата:

http://trackerdomain.com/?_lp=1&_token=info.token

info.token вы получите при первом запросе к API.

# Пример получения subid клика и записи его в переменную через Click API v3

$url = "https://domain_tracker/click_api/v3?token=szvkqdf1tk28n9pkwwk3t8tbv4v9&info=1";
$response = json_decode (file_get_contents ($url));
$subid = $response->info->sub_id;
var_dump($subid)

← WordPress Plugin →