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

Параметры

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=[17809]' \
     -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 - id кампании, которая принимает брокерские заявки, Иванов Иван Иванович - заполнитель заявки, мобильный телефон которого 03512345678, электронная почта - ivanov11123test@gmail.com, а 11.11.2016 - дата устройства на работу.

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

{
    "id": 1,
    "subid": "",
    "subid1": "",
    "subid3": "",
    "subid2": "",
    "subid4": "",
    "responses": [
        {
            "campaign_id": 1,
            "status": "processing",
            "order_id": null,
            "server_response": {
                "message": "objects_list_returned_ok",
                "code": 200,
                "data": false
            }
        }
    ],
    "errors": [
        {
            "campaign_id": 2,
            "message": "The company doesn't accept broker applications."
        }
    ]
}

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

Название Описание
id Идентификатор заявки
responses Информация об отправке заявки в кампании
errors Ошибки при создании заявки
subid Дополнительный параметр
subid1 Дополнительный параметр 1
subid2 Дополнительный параметр 2
subid3 Дополнительный параметр 3
subid4 Дополнительный параметр 4

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

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

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

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