Postback
- Создание постбэка
- Описание раздела
- Настройка запроса
- Список макросов
- Настройки аутентификации
- Тестирование постбэка
Создание постбэка
Создать постбэк можно в разделе https://gdeslon.ru/postbacks/
Чтобы добавить новый постбэк, нужно нажать на соответствующую кнопку «добавить постбэк».
Далее мы попадаем на страницу по созданию самого постбэка.
https://gdeslon.ru/postbacks/new/
Описание раздела
Название и условия постбэка
«Название» – наименование постбэка, указывается в произвольной форме.
«Адрес» – ссылка, куда будет отправляться запрос.
«При условии заказа у рекламодателя» - рекламодатель, по событию которого будет отправляться постбэк. Выбирается из выпадающего списка.
«При условии статуса заказа» – статусы, при которых будет отправляться постбэк на указанный ранее адрес.
Возможные варианты:
- потенциальный (created);
- отменен (cancelled);
- отложен (pending);
- подтвержден (confirmed);
- выплачен (payed).
Можно использовать несколько вариантов одновременно.
«Активен» -- это статус постбэка: работает или отключен.
При активном будут отправляться постбэки, при неактивном – не отправляются, но настройки сохранятся в разделе.
«Тип HTTP запроса»
Выбираем тип запроса. Два часто используемых метода запроса-ответа между клиентом и сервером: GET и POST.
После выбора типа GET можно сразу перейти к настройке передаваемых параметров.
При выборе отправки POST-запроса необходимо выбрать тип передаваемых параметров.
В json и xml прописывается тело запроса. Примеры:
JSON:
{ order_number: *order_id*, offer: *merchant_id*, earn: *profit* }
|
XML:
<root> <earn>*profit*</earn> <offer>*merchant_id*</offer> <order_number>*order_id*</order_number> </root>
|
«Передаваемые параметры» (если метод GET или POST с params)
В этом разделе добавляются параметры постбэков.
«Получаемое имя» – произвольное название, указывается вебмастером, в зависимости от того, в какой параметр на своей стороне он хочет получать.
«Значение» – макрос, который мы будем передавать в «получаемое имя».
Список макросов
Параметр | Описание |
---|---|
*gs_order_id* |
Номер заказа в системе гдеслон |
*merchant_id* |
Номер рекламодателя в системе гдеслон |
*sub_id*, *sub_id2*, etc |
Значения параметров sub_id |
*profit* |
Заработок вебмастера |
*order_id* |
Номер заказа рекламодателя |
*order_sum* |
Общая сумма заказа |
*click_time* |
Время перехода |
*action_time* |
Время создания заказа на стороне рекламодателя |
*user_agent* |
Идентификационная строка клиентского приложения |
*state* |
Cтатус конверсии. Принимает значения: 0 — потенциальный (created) 1 — отменен (cancelled) 2 — отложен (pending) 3 — подтвержден (confirmed) 4 — выплачен (payed) Можно выбрать несколько вариантов. |
*price_in_currency* |
Сумма в валюте |
*offer_name* |
Название оффера |
*currency* |
Валюта |
«HTTP headers»
В этом разделе настраиваются заголовки для аутентификации (если требуются). Если не требуются, можно оставить пустыми.
«Название» – наименование заголовка, например Authorization;
«Значение» – ключ авторизации.
«Сохранить», чтобы сохранить постбэк.
Тестирование постбэка (пример)
Для отправки данных используем сайт https://webhook.site/
Пример настроек:
Для отправки тестового постбэка нажать кнопку «Тестировать» через общий список в разделе https://gdeslon.ru/postbacks/
ИЛИ при просмотре конкретного постбэка:
Появится окно для ввода тестовых значений. Заполнить все интересующие поля и обязательно (!) указать merchant_id и state.
merchant_id – должен соответствовать айди рекламодателя;
status – должен соответствовать выбранным статусам, но в числовом значении.
Если эти два поля не будут заполнены – в ответе будет статус с ошибкой.
При успешной отправке постбэка внизу будет ответ со статусом 200.
Полученные данные в постбэке можем увидеть на тестовом сайте, куда мы отправляли запрос.