Ping back URL: Difference between revisions
No edit summary |
(Marked this version for translation) |
||
| Line 8: | Line 8: | ||
Request the activation of the '''Ping-back URL''' option from your manager for your integration. | Request the activation of the '''Ping-back URL''' option from your manager for your integration. | ||
<!--T:7--> | |||
Once enabled, specify your URL in the settings. | Once enabled, specify your URL in the settings. | ||
| Line 13: | Line 14: | ||
[[File:Ping back url.png]] | [[File:Ping back url.png]] | ||
<!--T:8--> | |||
To understand which impression we've checked, you need to mark it. If you have an '''JS check'''-type integration, add the <code>kmnrId</code> key to <code>window.kmnr</code> with any unique identifier convenient for you. By this identifier you can later recognize the impression. | To understand which impression we've checked, you need to mark it. If you have an '''JS check'''-type integration, add the <code>kmnrId</code> key to <code>window.kmnr</code> with any unique identifier convenient for you. By this identifier you can later recognize the impression. | ||
<!--T:9--> | |||
[[File:Ping back url2.png]] | [[File:Ping back url2.png]] | ||
<!--T:10--> | |||
If you have an '''Redirect'''-type integration, add kmnrId to URL: | If you have an '''Redirect'''-type integration, add kmnrId to URL: | ||
<!--T:11--> | |||
<pre>https://kaminari.systems/v1/click?kmnrKey=111111111&kmnrId=IMPRESSION_UNIQ_ID&u=https%3A%2F%2Fsome.url</pre> | <pre>https://kaminari.systems/v1/click?kmnrKey=111111111&kmnrId=IMPRESSION_UNIQ_ID&u=https%3A%2F%2Fsome.url</pre> | ||
<!--T:12--> | |||
Acceptable characters: [A-Za-z0-9_] Latin letters, Arabic numerals, underscore. Maximum length is 200 characters. | Acceptable characters: [A-Za-z0-9_] Latin letters, Arabic numerals, underscore. Maximum length is 200 characters. | ||
| Line 27: | Line 33: | ||
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. <code>{ kmnrId: 111111111, fraud: 1, block: 1 }</code> | 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. <code>{ kmnrId: 111111111, fraud: 1, block: 1 }</code> | ||
<!--T:13--> | |||
By kmnrId you can find the impression in your stat. | By kmnrId you can find the impression in your stat. | ||
Revision as of 09:54, 16 January 2024
If you want to receive the verification results for each click on your URL, you can do so using the Ping-back URL option.
Option activation
Request the activation of the Ping-back URL option from your manager for your integration.
Once enabled, specify your URL in the settings.
To understand which impression we've checked, you need to mark it. If you have an JS check-type integration, add the kmnrId key to window.kmnr with any unique identifier convenient for you. By this identifier you can later recognize the impression.
If you have an Redirect-type integration, add kmnrId to URL:
https://kaminari.systems/v1/click?kmnrKey=111111111&kmnrId=IMPRESSION_UNIQ_ID&u=https%3A%2F%2Fsome.url
Acceptable characters: [A-Za-z0-9_] Latin letters, Arabic numerals, underscore. Maximum length is 200 characters.
Response format
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. { kmnrId: 111111111, fraud: 1, block: 1 }
By kmnrId you can find the impression in your stat.
| Name | Value |
|---|---|
| kmnrId | kmnrId, unique identifier convenient for you |
| fraud | 1 if the click is fraudulent, 0 if the click is non-fraudulent, -1 if the click could not be verified |
| block | 1 if the click was blocked according to the integration settings, 0 if the click wasn't blocked |