Click API

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

Версия Click API 2

При запросе к API необходимо передавать «token» кампании. Взять его можно со страницы редактирования кампании, вкладка «Дополнительные настройки».

API URL

Click API доступен через обращение к следующим адресам:

  • /click_api/v2.
  • /api.php.

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

curl "http://keitarotds.soft.project/click_api/v2?token=ebd928ea"                             

Параметры

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

  • ip — IP адрес вида IPv4
  • user_agent
  • language
  • landing_id
  • uniqueness_cookie — текущее содержимое cookie
  • log — нужен ли лог обработки клика (1 или 0) 
  • info — получить блок info (1 или 0) 

Также параметры для кампаний какие_параметры_можно_передать_для_отчетов.

Ответ

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

Атрибут Тип Описание
headers array Массив header ответов
body string Тело ответа (например, текст страницы)
contentType string Тип ответа (в случае с json, будет «application/json; charset=utf-8»)
uniqueness_cookie string Cookie, которое необходимо отправлять в дальнейших запросах к Click API.
log array Содержимое лога обработки клика
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

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

curl "http://tracker.com/click_api/v2?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 Client.

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

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

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

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

Версия Click API 1

Смотрите страницу Click API v1 (outdated).