Ping back URL/ru: Difference between revisions

From Wiki Kaminari Click
(Created page with "Запрос должен вернуть HTTP 200.")
(Updating to match new version of source page)
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
<languages/>
<languages/>
<div class="mw-translate-fuzzy">
Подробнее о настройке Ping-back URL — в коротком видео:
https://www.loom.com/share/abe57191de9646599d7c317e77f4eccc
Если вы хотите получать на свой URL результат проверки по каждому клику, это можно сделать с помощью опции '''Ping-back URL'''.
Если вы хотите получать на свой URL результат проверки по каждому клику, это можно сделать с помощью опции '''Ping-back URL'''.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
If you want to receive the verification results for each click on your own URL, you can do so using the '''Ping-back URL''' option.
</div>


= Подключение опции =
= Подключение опции =
Line 27: Line 36:
Проверить работоспособность ping-back эндпойнта можно таким curl-запросом:
Проверить работоспособность ping-back эндпойнта можно таким curl-запросом:


<syntaxhighlight lang="bash">
curl -v -X POST -k 'https://example.com/ping-back' \
curl -v -X POST -k 'https://example.com/ping-back' \
   -H 'content-type: application/json' \
   -H 'content-type: application/json' \
   --data-raw '{"kmnrId":"50d9ecc6-402b-4a74-9397-fc20f2980567","kmnrKey":111111111,"fraud":1,"block":0,"reason":"Spoofing","sub1":"sub1 value","sub2":"sub2 value","sub3":"sub3 value","sub4":"","sub5":"","sub6":"","sub7":""}'
   --data-raw '{"kmnrId":"50d9ecc6-402b-4a74-9397-fc20f2980567","kmnrKey":111111111,"fraud":1,"block":0,"reason":"Spoofing","sub1":"sub1 value","sub2":"sub2 value","sub3":"sub3 value","sub4":"","sub5":"","sub6":"","sub7":""}'
</syntaxhighlight>


Замените:
Замените:
Line 41: Line 48:
Запрос должен вернуть HTTP 200.
Запрос должен вернуть HTTP 200.


<div lang="en" dir="ltr" class="mw-content-ltr">
= Формат ответа =
= Response format =
После получения и обработки данных и принятия решения о ботности клика мы отправляем вам решение в формате JSON POST.
After receiving, processing the data, and making a decision about the bot status of the click, we send the decision to you in JSON POST format.  
<pre>{
<pre>{
   "kmnrId": "50d9ecc6-402b-4a74-9397-fc20f2980567",
   "kmnrId": "50d9ecc6-402b-4a74-9397-fc20f2980567",
Line 57: Line 63:
   "sub7": ""
   "sub7": ""
}</pre>
}</pre>
</div>


По kmnrId и меткам вы сможете найти показ на своей стороне.
По kmnrId и меткам вы сможете найти показ на своей стороне.
Line 72: Line 77:
|-
|-
| block || 1 если переход был заблокирован в соответствии с настройками интеграции, 0 если переход не был заблокирован
| block || 1 если переход был заблокирован в соответствии с настройками интеграции, 0 если переход не был заблокирован
|-
| reason || Название категории IVT как в статистике: Поисковые боты, Подмена UA, Автоматизация, Плохие запросы, Ботовые IP. Для чистых переходов — пустая строка
|-
|-
| sub1 || метки, отправленные нам вместе с запросом
| sub1 || метки, отправленные нам вместе с запросом

Latest revision as of 08:02, 17 September 2026

Other languages:

Подробнее о настройке Ping-back URL — в коротком видео: https://www.loom.com/share/abe57191de9646599d7c317e77f4eccc

Если вы хотите получать на свой URL результат проверки по каждому клику, это можно сделать с помощью опции Ping-back URL.

If you want to receive the verification results for each click on your own URL, you can do so using the Ping-back URL option.

Подключение опции

Закажите у менеджера включение опции Ping-back URL на своей интеграции.

После того как её включат, укажите в настройках свой URL.

Ping back url.png

kmnrId

Чтобы понимать какой показ мы проверили вам надо пометить его.

Если у вас интеграция типа JS check, то добавьте в window.kmnr ключ kmnrId с любым удобным для вас уникальным идентификатором, по которому сможете потом узнать показ.

Ping back url2.png

В интеграции типа Redirect добавьте kmnrId в URL:

https://kaminari.systems/v1/click?kmnrKey=111111111&kmnrId=IMPRESSION_UNIQ_ID&u=https%3A%2F%2Fsome.url

Допустимые символы: [A-Za-z0-9_] латинские буквы, арабские цифры, знак подчёркивания. Максимальная длина — 200 символов.

Проверка эндпойнта

Проверить работоспособность ping-back эндпойнта можно таким curl-запросом:

curl -v -X POST -k 'https://example.com/ping-back' \

 -H 'content-type: application/json' \
 --data-raw '{"kmnrId":"50d9ecc6-402b-4a74-9397-fc20f2980567","kmnrKey":111111111,"fraud":1,"block":0,"reason":"Spoofing","sub1":"sub1 value","sub2":"sub2 value","sub3":"sub3 value","sub4":"","sub5":"","sub6":"","sub7":""}'

Замените:

  • https://example.com/ping-back — ping-back URL клиента
  • 111111111 — его kmnrKey
  • 50d9ecc6-402b-4a74-9397-fc20f2980567 — любой случайный kmnrId

Запрос должен вернуть HTTP 200.

Формат ответа

После получения и обработки данных и принятия решения о ботности клика мы отправляем вам решение в формате JSON POST.

{
   "kmnrId": "50d9ecc6-402b-4a74-9397-fc20f2980567",
   "kmnrKey": 111111111,
   "fraud": 1,
   "block": 1,
   "sub1": "sub1 value",
   "sub2": "sub2 value",
   "sub3": "sub3 value",
   "sub4": 444,
   "sub5": 555,
   "sub6": "",
   "sub7": ""
}

По kmnrId и меткам вы сможете найти показ на своей стороне.

Название Значение
kmnrId kmnrId, уникальный идентификатор
kmnrKey Идентификатор интеграции
fraud 1 если переход фродовый, 0 если переход нефродовый
block 1 если переход был заблокирован в соответствии с настройками интеграции, 0 если переход не был заблокирован
reason Название категории IVT как в статистике: Поисковые боты, Подмена UA, Автоматизация, Плохие запросы, Ботовые IP. Для чистых переходов — пустая строка
sub1 метки, отправленные нам вместе с запросом
sub2 ...
sub3 ...
sub4 ...
sub5 ...
sub6 ...
sub7 ...

После успешного получения ping-back ваш сервер должен ответить статусом 200. Иначе мы попробуем ещё три раза отправить запрос.

Если ping-back по-прежнему не может быть доставлен, вы всегда можете получить статус любого клика через наш API, который служит надежным источником информации независимо от успешности доставки.