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

Параметры

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

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

Название Описание Тип Ограничения
campaign_id * ID программы, которой нужно отправить заявки int Список партнёрских программ (has_tool=broker_traffic has_sms_verification_for_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' -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-верификацией

Параметры

HTTP метод Права доступа URL Параметры Примечание
POST manage_broker_application https://api.admitad.com/website/{w_id}/broker/applications/sync_create/{a_id}/confirm Список параметров для запроса

Возвращает созданную заявку, гдe w_id — идентификатор площадки.* a_id — идентификатор заявки.*

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

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

Название Описание Тип
code *

Код из SMS-сообщения

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

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

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