Заявки брокера

Параметры заявки

Требования к параметрам заявки могут переопределяться каждой программой отдельно — Настройки полей программы

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

Параметры

• * Возвращает результат в формате JSON.
  
  

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

• * Обязательный параметр
  
  

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

Пример запроса с использованием утилиты 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-сервера

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

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

Создание заявок брокера для банков с SMS-верификацией

Параметры

• * Возвращает результат в формате JSON.

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

• * Обязательный параметр

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

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

curl -H 'Authorization: Bearer access_token' -H "accept: application/json" -X POST

https://api.admitad.com/website/\{w_id}/broker/applications/sync_create/ -d

'campaign_id=65&first_name=Иван&last_name=Иванов&middle_name=Иванович&mobile_phone=03512345678&work_date=11.11.2016&email=ivanov11123test@gmail.com'

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

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

{

    "status": "waiting_sms_verification",

    "application_id": 123,

    "server_response":

        {

            "bank": "responded this"

        },

}

Подтверждение заявок брокера для банков с SMS-верификацией

Параметры

• * Возвращает результат в формате JSON.

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

• * Обязательный параметр

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

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

curl -H 'Authorization: Bearer access_token' -H "accept: application/json" -X POST

https://api.admitad.com/website/\{w_id}/broker/applications/sync_create/\{a_id}/confirm -d 'code=1234'

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

{

    "status": "waiting_sms_verification",

    "application_id": 123,

    "server_response":

        {

            "bank": "responded this"

        },

}

Список заявок брокера

Параметры

• * Возвращает результат в формате JSON.

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

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

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

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

'https://api.admitad.com/website/{w_id}/broker/applications/?offset=0&limit=1'

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

{

    "results": [

        {

            "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

                    }

                }

            ],

            "algorithm": [{
"ids": [17809],"pause": 0}],

        }

    ],

    "_meta": {

        "count": 1,

        "limit": 1,

        "offset": 0

    }

}

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

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

Настройки полей программы

Параметры

• * Возвращает результат в формате JSON.

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

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

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

'https://api.admitad.com/broker/campaign_settings/{c_id}/'

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

{

    "results": [

        {

            "field_name": "first_name",

            "regexp": "^[a-zA-Z]+$",

            "required": true,

            "description": ""

        },

        {

            "field_name": "last_name",

            "regexp": "^[a-zA-Z]+$",

            "required": true,

            "description": ""

        },

        {

            "field_name": "middle_name",

            "regexp": "",

            "required": true,

            "description": ""

        },

        {

            "field_name": "product_type",

            "regexp": "^[1,3,7,8]{1}$",

            "required": true,

            "description": "1-credit; 3-card; 7-gold-card; 8-platinum-card"

        }

    ]

}

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