# Click API Client

PHP-скрипт для интеграции внешних сайтов.

# Возможности

  • Передача информации о текущем посетителе в Keitaro.
  • Передача параметров из адресной строки.
  • Обработка и выполнение инструкций Keitaro: показ текста, выполнение редиректа.

# Использование

  • Зайдите в Keitaro, на страницу кампании;
  • Перейдите в окно «Интеграция»;
  • Выберите «KClient PHP».
  • Скачайте файл kclick_client.php и положите его в директорию вашего сайта.
  • Затем скопируйте код и вставьте в шаблон сайта, в самом начале шаблона, до и DOCTYPE
  • Следуя инструкции, установите код на вашем сайте.

# Инициализация клиента

require_once 'kclick_client.php'; // файл должен быть загружен в туже директорию, что и страница
$client = new KClickClient('АДРЕС API', 'токен кампании');

# Описание методов

Метод Описание
$client->sendAllParams(); Передача параметров из адресной строки
$client->forceRedirectOffer(); Если в потоке был выбран оффер, то выполнить редирект на него. В ином случае нужно использовать getOffer()
$client->params('param1=c&param2=b'); Передача строки параметров
$client->param('extra_param_5', '123'); Альтернативный способ передачи параметра
$client->sendUtmLabels(); Передача из адресной строки только utm-меток
$client->debug(); Показ отладочной информации
$client->currentPageAsReferrer(); Отправить адрес текущей страницы в качестве реферера
$client->keyword('KEYWORD'); Использование значения 'KEYWORD' в качестве ключевика
$client->execute(); Выполнение инструкций Keitaro и с продолжением выполнения кода страницы
$client->executeAndBreak(); Выполнение инструкций Keitaro с остановкой выполнения страницы. Если передано действие в потоке «Ничего не делать», остановки не произойдет.
$client->getOffer(); Получение ссылки на оффер. В кампании должен быть поток со схемой «Офферы», иначе результат 'no_offer'.
$client->getBody(); Получение содержимого 'body'.
$client->getHeaders(); Получение заголовков (headers)
$client->isUnique(level); Статус уникальности (варианты level: stream, campaign, global)
$client->isBot(); Статус бота
$client->restoreFromQuery() Ловит параметры _subid и _token из запроса и не заводит нового клика
$client->restoreFromSession() Восстанавливает предыдущее посещение из сессии и не заводит нового клика

# Как сделать ссылку на оффер?

Пример использования KClickClient для генераци ссылки на оффер:

<?php
require_once 'kclick_client.php';
$client = new KClickClient('http://example.con/api.php', 'token');
?>
<html>
...
<body>
<a href="<?php echo $client->getOffer() ?>">CLICK!</a>
</body>
</html>

В потоке должна использоваться схема «Лендинги» или «Офферы».

Если нужно вызвать определенный оффер, передавайте параметр offer_id:

<a href="<?php echo $client->getOffer(array('offer_id' => 123), '#');?>">LINK</a>

Если есть вероятность, что трекре не вернет оффер, можно выставить ссылку по умолчанию вторым параметром:

<a href="<?php echo $client->getOffer(null, 'http://ya.ru');?>">LINK</a>

# Отправка постбека

Для отправки постбека, вам потребуется subid, его можно получить через $client->getSubid(); и положить в сессию:

...
$_SESSION['subid'] = $client->getSubid();

На странице, с которой нужно отправляется постек, берите subid из сессии:

$url = 'http://tds/POSTBACK_KEY/postback?payout=100&status=sale&subid=' . urlencode($_SESSION['subid']);
file_get_contents($url);