Sections in this category

Коды оптимизации

  • Обновлено

Список кодов оптимизации

Параметры

HTTP метод Права доступа URL Параметры Примечание
GET opt_codes https://api.admitad.com/opt_codes/
  • limit**
  • offset**
  • campaign***
  • website***
  • order_by****
Возвращает список кодов оптимизации*.
GET opt_codes https://api.admitad.com/opt_codes/{id}/   Возвращает код оптимизации, где id — это идентификатор кода*.
  • * Возвращает результат в формате JSON.
  • ** Задаёт пропуск и количество возвращаемых записей. Например limit=5&offset=2.
  • *** Фильтр по партнерским программам и площадкам веб-мастера соответственно. Например campaign=3&website=12, где значения — это идентификаторы фильтруемых категорий.
  • **** Порядок сортировки. Возможные значения:
    • action_type
    • method
    • desc_mode

    Знак '-' перед значением означает обратный порядок. Например order_by=-method&order_by=desc_mode.

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/opt_codes/?limit=2

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/opt_codes/3/

Пример ответа API-сервера в формате JSON:

{
    "results": [
{
"campaign": null,
"desc_mode": 0,
"event": 0,
"generated_url": "http://127.0.0.1:8000/?oid=[[[offer_id]]]&oname=[[[offer_name]]]&ostat=[[[offer_status]]]",
"id": 11,
"method": 0,
"status": [
{
"id": 8
}
],
"user_url": "http://127.0.0.1:8000/",
"website": null,
"reward_ready": true
},
{
"campaign": null,
"desc_mode": 0,
"event": 0,
"generated_url": "http://127.0.0.1:8000/?1=[[[offer_id]]]&2=[[[offer_name]]]&3=[[[offer_status]]]&4=[[[offer_status]]]&6=[[[offer_status]]]&7=[[[offer_id]]]",
"id": 15,
"method": 0,
"status": [
{
"id": 5
}
],
"user_url": "http://127.0.0.1:8000/",
"website": null,
"reward_ready": false
}
],
"_meta": {
"count": 3,
"limit": 2,
"offset": 0
}
}

Описание полей ответа API-сервера

Название Описание
id Идентификатор кода
website Площадка
campaign Партнерская программа
event Тип события по которому срабатывает код (0 — действие, 1 — изменение статуса программы, 2 — подключение реферала)
status Статус действия. Работает только для действий (5 — новая, 6 — принята, 7 — отклонена, 8 — ожидает)
reward_ready Вознаграждение перешло в статус «Готовы к снятию» или из него. Работает только для действий
desc_mode Режим настройки кода (0 — расширенный режим, 1 — простой режим)
action_type Тип действия (0 — Все типы, 1 — Sale, 2 — Lead)
method Метод запроса (0 — GET, 1 — POST)
user_url URL пользователя
generated_url Сгенерированный URL

Создание кодов оптимизации по действию

Параметры

HTTP метод Права доступа URL Параметры Примечание
POST manage_opt_codes https://api.admitad.com/opt_codes/action/create/ Список параметров для запроса
  • * Возвращает результат в формате JSON.

Список параметров для запроса

Название Тип Обязательный Ограничения параметров Допустимые значения
website integer     Список площадок веб-мастера
campaign integer     Список партнерских программ
desc_mode integer   0 для расширенного режима и 1 для простого
url string    
method integer   0 для GET метода и 1 для POST
action_type integer   0 для всех типов действия, 1 для Sale и 2 для Lead
status integer Обязательно передавать хотя бы один из параметров: status или reward_ready  
  • 5 — новая, 6 — принята, 7 — отклонена, 8 — ожидает
reward_ready integer  
  • 0 — не получать уведомления о переходе вознаграждения в статус «Готовы к снятию» или из него
  • 1 — получать уведомления о переходе вознаграждения в статус «Готовы к снятию» или из него
Название Параметр
ID партнёрской программы [[[offer_id]]]
Название партнёрской программы [[[offer_name]]]
Название площадки [[[website_name]]]
ID площадки [[[website_id]]]
SubID [[[subid]]]
Сумма вашего заработка [[[payment_sum]]]
Вознаграждение перешло в статус «Готовы к снятию» [[[reward_ready]]]
Валюта программы [[[currency]]]
Номер заказа [[[order_id]]]
Сумма заказа [[[order_sum]]]
Время клика(unix-время) [[[click_time]]]
Время действия(unix-время) [[[time]]]
Время конверсии(в секундах) [[[conversion_time]]]
Тип действия [[[type]]]
IP действия [[[action_ip]]]
User-Agent [[[user_agent]]]

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X POST

https://api.admitad.com/opt_codes/action/create/ -d
'website=33&campaign=6&status=6&status=7&reward_ready=1&desc_mode=0&method=1&action_type=1&url=http%3A//test.com/%3Foffer_id%3D%5B%5B%5Boffer_id%5D%5D%5D%26time%3D%5B%5B%5Btime%5D%5D%5D'

Пример ответа API-сервера в формате JSON:

{
"campaign": {
"id": 6,
"name": "AdvCamp"
},
"desc_mode": 0,
"event":0,
"generated_url": "http://test.com/?offer_id=[[[offer_id]]]&time=[[[time]]]",
"id": 18,
"method": 1,
"status": [
{
"id": 6
},
{
"id": 7
}
],
"user_url": "http://test.com/",
"website": {
"id": 33,
"name": "AdRiver"
},
"reward_ready": true
}

Описание полей ответа API-сервера

Создание кодов оптимизации по изменению статуса программы

Параметры

HTTP метод Права доступа URL Параметры Примечание
POST manage_opt_codes https://api.admitad.com/opt_codes/offer/create/ Список параметров для запроса
  • * Возвращает результат в формате JSON.
Название Параметр
ID партнёрской программы [[[offer_id]]]
Название партнёрской программы [[[offer_name]]]
Статус программы [[[offer_status]]]

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X POST

https://api.admitad.com/opt_codes/offer/create/ -d
'website=33&campaign=6&desc_mode=0&method=1&action_type=1&url=http%3A//test.com/%3Foffer_id%3D%5B%5B%5Boffer_id%5D%5D%5D%26offer_status%3D%5B%5B%5Boffer_status%5D%5D%5D'

Пример ответа API-сервера в формате JSON:

{
"campaign": {
"id": 6,
"name": "AdvCamp"
},
"desc_mode": 0,
"event": 1,
"generated_url": "http://test.com/?offer_id=[[[offer_id]]]&offer_status=[[[offer_status]]]",
"id": 20,
"method": 1,
"status": [],
"user_url": "http://test.com/",
"website": {
"id": 33,
"name": "AdRiver"
},
}

Описание полей ответа API-сервера

Редактирование кодов оптимизации по действию

Параметры

HTTP метод Права доступа URL Параметры Примечание
POST manage_opt_codes https://api.admitad.com/opt_codes/action/update/{id}/ Список параметров для запроса
  • Формат данных запроса application/x-www-form-urlencodedе.
  • Возвращает изменённый код оптимизации, где id — это идентификатор площадки*.
  • * Возвращает результат в формате JSON.

Список параметров ссылки

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X POST

https://api.admitad.com/opt_codes/action/update/24/ -d
'campaign=6&desc_mode=1&method=1&action_type=1&reward_ready=1'

Пример ответа API-сервера в формате JSON:

{
    "campaign": {
"id": 6,
"name": "AdvCamp"
},
"desc_mode": 0,
"event": 0,
"generated_url": "http://test.com/?offer_id=[[[offer_id]]]&offer_name=[[[offer_name]]]&website_name=[[[website_name]]]&website_id=[[[website_id]]]&subid=[[[subid]]]&payment_sum=[[[payment_sum]]]&reward_ready=[[[reward_ready]]]&currency=[[[currency]]]&order_id=[[[order_id]]]&order_sum=[[[order_sum]]]&click_time=[[[click_time]]]&time=[[[time]]]&conversion_time=[[[conversion_time]]]&type=[[[type]]]&action_ip=[[[action_ip]]]&user_agent=[[[user_agent]]]",
"id": 22,
"method": 1,
"status": [],
"user_url": "http://test.com/",
"website": {
"id": 33,
"name": "AdRiver"
},
"reward_ready": true
}

Описание полей ответа API-сервера

Редактирование кодов оптимизации по изменению статуса программы

Параметры

HTTP метод Права доступа URL Параметры Примечание
POST manage_opt_codes https://api.admitad.com/opt_codes/offer/update/{id}/ Список параметров для запроса
  • Формат данных запроса application/x-www-form-urlencoded.
  • Возвращает изменённый код оптимизации, где id — это идентификатор площадки*.
  • * Возвращает результат в формате JSON.

Список параметров ссылки

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X POST

https://api.admitad.com/opt_codes/offer/update/24/ -d
'campaign=6&desc_mode=1&method=1&action_type=1'

Пример ответа API-сервера в формате JSON:

{
    "campaign": {
"id": 6,
"name": "AdvCamp"
},
"desc_mode": 0,
"event": 1,
"generated_url": "http://test.com/?offer_id=[[[offer_id]]]&offer_name=[[[offer_name]]]",
"id": 21,
"method": 1,
"status": [],
"user_url": "http://test.com/",
"website": {
"id": 33,
"name": "AdRiver"
},
}

Описание полей ответа API-сервера

Удаление кодов оптимизации

Параметры

HTTP метод Права доступа URL Примечание
POST manage_opt_codes https://api.admitad.com/opt_codes/delete/{id}/ Возвращает результат операции, где id — это идентификатор площадки*.
  • * Возвращает результат в формате JSON.

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X POST https://api.admitad.com/opt_codes/delete/24/

Пример ответа API-сервера в формате JSON:

{"message": "The code record was deleted successfully", "success": "Deleted"}

Была ли эта статья полезной?

Пользователи, считающие этот материал полезным: 0 из 0