Создание заявок брокера

Параметры

HTTP метод Права доступа URL Параметры Примечание
POST manage_broker_application https://api.admitad.com/website/{w_id}/broker/applications/create/ Список параметров для запроса Возвращает созданную заявку, гдe w_id - идентификатор площадки.*
  • * Возвращает результат в формате JSON.

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

Название Описание Тип Ограничения
campaigns *

Список ID программ, в которые нужно разослать заявки или Алгоритм отправки анкеты.

list Список партнёрских программ (has_tool=broker_traffic)
user_notified * Значение “1” — пользователь ознакомлен и согласен с целью сбора данных, операциями по обработке данных, перечнем третьих лиц, которым будут переданы данные, и своими правами согласно пункту 2.1 Правил использования инструмента «Брокер». Значение “0” — пользователь не ознакомлен и не согласен. При получении этого значения анкета пользователя не будет передана по API. bool 1 или 0
test_mode Отправка заявки в тестовом режиме. В тестовом режиме в ответе будет отсутствовать ‘id’ и ‘responses’ будет пустой. bool 1 или 0
Остальные Параметры заявки      
  • * Обязательный параметр

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

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

curl -H 'Authorization: Bearer access_token' -X POST https://api.admitad.com/website/{w_id}/broker/applications/create/ \
     -F 'campaigns=[17809, 17810]' \
     -F 'first_name=Иван' \
     -F 'last_name=Иванов' \
     -F 'middle_name=Иванович' \
     -F 'mobile_phone=03512345678' \
     -F 'work_date=11.11.2016' \
     -F 'email=ivanov11123test@gmail.com'

где 17809, 17810 - ID программ, которые принимают брокерские заявки, Иванов Иван Иванович — заполнитель заявки, мобильный телефон которого 03512345678, электронная почта — ivanov11123test@gmail.com, а 11.11.2016 — дата устройства на работу.

Алгоритм отправки анкеты

Параметр “campaigns” может принимать JSON массив с алгоритмом отправки анкеты:

campaigns=[{"ids": [17809, 16126], "pause": 0}, {"ids": [17288, 16651], "pause": 150}, {"ids": [16633], "pause": 80}]

где:

  • ids - список id офферов группы
  • pause - пауза в минутах перед отправкой группы (максимальнное 1440 мин. - сутки)

В приведенном выше примере, для первой группы: [17809, 16126] анкета будет отправлена сразу же, без паузы. Если хотя бы одна анкета была успешной (рекламодатель принял ее по API без отказов), то через 150 минут будет запущена отправка анкет на вторую группу офферов [17288, 16651]. Если же все анкеты первой группы были отклонены при отправке рекламодателю, то отправка на вторую группу офферов будет без паузы в 150 минут. Далее по этому же принципу через 80 минут(или без паузы) анкета будет отправлена на третью группу.

Поддерживаются разные варианты записи параметра “campaigns”, например:

[17809, 16126, [17288, 16651], {"ids": [16633]}, {"ids": [16326, 14605], "pause": 150}]

будет эквивалентна записи:

[{"ids": [17809], "pause": 0},
 {"ids": [16126], "pause": 0},
 {"ids": [17288, 16651], "pause": 0},
 {"ids": [16633], "pause": 0},
 {"ids": [16326, 14605], "pause": 150}]

Посмотреть как интерпритируется ваша запись можно в параметре “algorithm” ответа API-сервера

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

{
    "id": 1,
    "subid": "",
    "subid1": "",
    "subid3": "",
    "subid2": "",
    "subid4": "",
    "responses": [
        {
            "campaign_id": 17809,
            "status": "processing",
            "order_id": null,
            "server_response": {
                "message": "objects_list_returned_ok",
                "code": 200,
                "data": false
            }
        }
    ],
    "errors": [
        {
            "campaign_id": 17810,
            "message": "Кампания не принимает заявки брокеров."
        }
    ],
    "algorithm": [{"ids": [17809], "pause": 0}],
}

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

Название Описание
id Идентификатор заявки
responses

Информация об отправке заявки в программы

errors Ошибки при создании заявки
subid Дополнительный параметр
subid1 Дополнительный параметр 1
subid2 Дополнительный параметр 2
subid3 Дополнительный параметр 3
subid4 Дополнительный параметр 4
algorithm Алгоритм отправки анкеты

Описание полей в информации об отправке заявки в программы

Название Описание
campaign_id

Идентификатор программы

status
Статус отправки:
  • processing (в очереди на отправку в программу)

  • approved (одобрена программой)

  • declined (отклонена программой)

  • waiting (обрабатывается программой)

  • error (ошибки на стороне программы)

order_id ID заказа в системе
server_response Ответ сервера рекламодателя

Описание полей ошибок при создании заявки

Название Описание
campaign_id

Идентификатор программы

message Сообщение об ошибке