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

Параметры

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)
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=[1,2]' \
     -F 'first_name=first_name' \
     -F 'last_name=last_name' \
     -F 'middle_name=middle_name' \
     -F 'mobile_phone=03512345678' \
     -F 'work_date=11.11.2016' \
     -F 'email=test@gmail.com'

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

{
    "id": 1,
    "first_name": "first_name",
    "last_name": "last_name",
    "middle_name": "middle_name",
    "birth_date": null,
    "birth_place": "",
    "gender": "",
    "mobile_phone": "03512345678",
    "phone": "",
    "occupation": "",
    "work_date": "2016-11-11",
    "work_salary": null,
    "work_organization": "",
    "work_address": "",
    "work_phone": "",
    "work_occupation": "",
    "email": "test@gmail.com",
    "inn": "",
    "passport_cn": "",
    "passport_date": null,
    "passport_title": "",
    "fact_region_name": "",
    "fact_city_name": "",
    "fact_street": "",
    "fact_house": "",
    "fact_housing": "",
    "fact_flat": "",
    "reg_region_name": "",
    "reg_city_name": "",
    "reg_street": "",
    "reg_house": "",
    "reg_housing": "",
    "reg_flat": "",
    "overdue_loans": "",
    "credit_sum": null,
    "credit_days": null,
    "product_type": "",
    "subid": "",
    "subid1": "",
    "subid3": "",
    "subid2": "",
    "subid4": "",
    "responses": [
        {
            "campaign_id": 1,
            "status": "processing",
            "order_id": null
        }
    ],
    "errors": [
        {
            "campaign_id": 2,
            "message": "The company doesn't accept broker applications."
        }
    ]
}

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

Название Описание
id Идентификатор заявки
responses Информация об отправке заявки в кампании
errors Ошибки при создании заявки
Остальные Параметры заявки  

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

Название Описание
campaign_id Идентификатор кампании
status
Статус отправки:
  • processing (в очереди на отправку в кампанию)
  • approved (одобрена кампанией)
  • declined (отклонена кампанией)
  • waiting (обрабатывается кампанией)
  • error (ошибки на стороне кампании)
order_id ID заказа в системе

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

Название Описание
campaign_id Идентификатор кампании
message Сообщение об ошибке