Postback — механизм отправки данных о событиях (создание, подтверждение, аннулирование конверсий) в системе посредством GET или POST запросов.
Postback позволяет синхронизировать данные о транзакции из партнерской сети со сторонней системой анализа трафика web-мастера.
Чаще всего применяются, если площадка web-мастера представляет собой cashback-сервис, с которым как раз и нужно синхронизировать статус транзакции, для дальнейшей выплаты кэшбека пользователю.
После совершения целевого действия пользователем на сайте (регистрации, покупки и т.д.) или изменения статуса конверсии, в зависимости от настройки Postback-a, партнерская программа должна вызвать указанную при настройках ссылку с необходимыми параметрами или данными, в зависимости от настройки.
Постбеки отправляются с прокси 5.182.6.7, если у вас есть whitelist, то в него необходимо добавить адрес этого сервера.
Для настройки Postback-ов необходимо заполнить следующий поля:
Поле | Значение |
|---|---|
Площадки | Выбор площадок, для событий которых будут отправлены запросы. |
Офферы | Выбор оффера, для отправки запроса. |
События | Тип событий в системе для которых могут быть отправлены запросы. |
Предзаказ | Используется в случаях, когда подтверждение осуществления конверсии от клиента, происходит с задержкой (более 15 минут). |
Конверсия создана | Конверсия была создана и ей существование в базе клиента было подтверждено. Комиссия web-мастера по правилам системы рассчитана. |
Конверсия подтверждена и закончился HOLD | Конверсия подтверждена клиентом, комиссия будет выплачена web-мастеру после завершения HOLD. Это конечный статус, который не может быть изменен в автоматическом режиме. |
Конверсия аннулирована | Заказ был аннулирован клиентом, комиссия НЕ будет выплачена web-мастеру. Это конечный статус, который не может быть изменен в автоматическом режиме. |
Метод HTTP запроса | |
GET | Применяется для передачи данных заданному ресурсу с использованием дополнительных параметров url адреса. |
POST | Применяется для передачи данных заданному ресурсу в теле запроса. |
Postback URL | Url-адрес ресурса куда должны быть переданы данные. |
Content-Type | Пример: |
plain | cid=$CLICK_ID$ &id=$CONVERSION_ID$ |
json | {
"clickId": "$CLICK_ID$",
"conversionId": "$CONVERSION_ID$",
"conversionSum": "$CONVERSION_SUM$"
} |
xml | <xml version="1.0" encoding="UTF-8"> <clickId>$CLICK_ID$ </clickId> <conversionSum>$CONVERSION_SUM$ </conversionSum> <conversionId>$CONVERSION_ID$ </conversionId> |
Тело запроса | Тело запроса с использованием макросов |
Заголовки | Позволяет задать произвольные заголовки для HTTP запросов. Не более 5 значений. |
Проверка ответа | Если ответ сервера не соответствует указанным условиям, то отправка запроса будет повторяться через 1 час в течение 7 дней. |
Статус ответа | Код ответа (состояния) HTTP показывает, был ли успешно выполнен определённый HTTP запрос. Проверка на ответ: 200, 201 или 204 |
Тело ответа | Строка для сравнения с телом ответа сервера postback. Оставьте значение пустым, если не хотите проверять тело ответа. |
Макросы
Для настройки Postback используются макросы — специальные переменные, которые подставляются в URL или Тело запроса, и при отправке будут заменены на соответствующие значения:
Макрос | Значение |
|---|---|
$CONVERSION_ID$ | Уникальный идентификатор заказа |
$CONVERSION_TIMESTAMP$ | Время конверсии в формате Unix timestamp |
$CONVERSION_TIME:YYYY-MM-DD HH:mm:ss$ | Время заказа, формат после двоеточия может быть произвольным |
$NOW:YYYY-MM-DD HH:mm:ss$ | Текущее время сервера, формат после двоеточия может быть произвольным |
$CONVERSION_DATE:YYYY-MM-DD$ | Дата заказа, формат после двоеточия может быть произвольным |
$CONVERSION_UPDATED:YYYY-MM-DD HH:mm:ss$ | Дата обновления заказа, формат после двоеточия может быть произвольным |
$CONVERSION_SUM$ | Сумма заказа |
$CONVERSION_STATUS$ | Статус заказа: |
Создан | Можно указать свое значение (по умолчанию передается 1) |
Подтвержден | Свое значение / по умолчанию - 2 |
Аннулирован | Свое значение / по умолчению - 3 |
$RULE_IDS$ | Идентификаторы правил или значений из маппинга, разделенные запятой |
$WEBMASTER_REWARD$ | Комиссия web-мастера. |
$WEBSITE_ID$ | Уникальный идентификатор площадки |
$WEBSITE_ALIAS$ | Уникальный Алиас площадки |
$CLICK_ID$ | Значение из GET параметра clickid |
$SUB$ | Значение из GET параметра sub |
Про параметры Sub и ClickID
GET параметр sub предназначен для разделения трафика внутри площадки. Например, для обозначения, разделения разных типов баннеров на сайте или деления по менеджерам. Имеет ограничение в 100 символов для одного sub.
GET параметр clickid предназначен для фиксации информации о клике от внешних сервисов. В основном используется внешними сервисами для начисления комиссии внутри системы. Например, к партнерской программе подключается кэшбек сервис, к каждому переходу в url добавляет уникальное значение clickid. После совершения конверсии пользователем, кэшбек сервис получит Postback с информацией по сумме заказа и значению clickid при переходе. По значению clickid кэшбэк сервис внутри своей системы определят информацию о пользователе, который совершил переход, дате и времени перехода. По значению суммы заказа рассчитывается сумма вознаграждения пользователя.
Логирование Postback
Для того чтобы скачать лог Postback-а, необходимо зайти в раздел Инструменты - Постбэки.
Далее необходимо скопировать id Postback-а, нажать кнопку "скачать лог". В открывшемся окне вставляем id, выбираем требуемый период, формат файла и нажимаем кнопку "скачать".