#315: Заявки брокера

Отредактирована: 11 дней назад

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

Название	Описание	Тип	Ограничения
first_name	Имя	string	max length	100
last_name	Фамилия	string	max length	100
middle_name	Отчество	string	max length	100
birth_date	День рождения	date	format	%d.%m.%Y
birth_place	Место рождения	string	max length	100
gender	Пол	string	max length	50
mobile_phone	Мобильный телефон	string	max length	32
phone	Городской телефон	string	max length	32
occupation	Вид занятости	string	max length	100
work_date	Дата устройства на работу	date	format	%d.%m.%Y
work_salary	Заработная плата	decimal	max no. of digits	12
			decimal places	2
work_organization	Название организации	string	max length	100
work_address	Адрес места работы	string	max length	100
work_phone	Телефон организации	string	max length	32
work_occupation	Должность	string	max length	100
work_region_name	Адрес места работы: регион	string	max length	50
work_city_name	Адрес места работы: город	string	max length	50
work_street	Адрес места работы: улица	string	max length	50
work_house	Адрес места работы: дом	string	max length	10
email	Почтовый адрес	string	max length	75
inn	ИНН	string	max length	16
passport_cn	Серия и номер паспорта	string	max length	16
passport_date	Дата выдачи паспорта	date	format	%d.%m.%Y
passport_expiration_date	Дата истечения действия паспорта	date	format	%d.%m.%Y
passport_title	Кем выдан паспорт	string	max length	100
fact_region_name	Фактическое проживание: регион	string	max length	50
fact_city_name	Фактическое проживание: город	string	max length	50
fact_street	Фактическое проживание: улица	string	max length	50
fact_house	Фактическое проживание: дом	string	max length	10
fact_housing	Фактическое проживание: строение	string	max length	10
fact_flat	Фактическое проживание: квартира	string	max length	10
reg_region_name	По прописке: регион	string	max length	50
reg_city_name	По прописке: город	string	max length	50
reg_street	По прописке: улица	string	max length	50
reg_house	По прописке: дом	string	max length	10
reg_housing	По прописке: строение	string	max length	10
reg_flat	По прописке: квартира	string	max length	10
overdue_loans	Кредитная история	string	max length	50
credit_sum	Сумма займа	decimal	max no. of digits	12
			decimal places	2
credit_days	Срок займа	integer
credit_purpose	Цель кредита	string	max length	300
time_for_call	Время звонка	string	max length	300
guarator	Поручитель	string	max_length	100
guarantor_type	Кем приходится поручитель	string	max_length	100
guarantor_phone	Телефон поручителя	string	max length	32
product_type	Тип продукта	string	max length	50
personal_data_agent	Источник трафика (сайт или юр. лицо)	string	max length	300
application_received_date_by_client	Дата получения заявки клиентом	date	format	%d.%m.%Y
subid	Дополнительный параметр	string	max length	50
			shall not be used: "%00"
subid1	Дополнительный параметр 1	string	max length	50
			shall not be used: "%00"
subid2	Дополнительный параметр 2	string	max length	50
			shall not be used: "%00"
subid3	Дополнительный параметр 3	string	max length	50
			shall not be used: "%00"
subid4	Дополнительный параметр 4	string	max length	120
			shall not be used: "%00"

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

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

Параметры

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

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

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

Название	Описание	Тип	Ограничения
campaigns*	Список ID программ, в которые нужно разослать заявки или Алгоритм отправки анкеты.	list	Список партнерских программ (traffic_types=20)
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	Сообщение об ошибке

Создание заявок брокера для банков с 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)
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"  
        },  
}

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

Параметры

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

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

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

Название	Тип	Ограничения
offset	integer	Параметры limit, offset
limit	integer	Параметры limit, offset
order_by	string	date_created
		Знак ‘-‘ перед значением означает обратный порядок. Например, order_by=-date_created
id	integer
campaign	integer	Список партнерских программ
status	string	processing
		approved
		declined
		waiting
		error
date_start	date	%d.%m.%Y
date_end	date	%d.%m.%Y
order_id	string
subid	string
subid1	string
subid2	string
subid3	string
subid4	string

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

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

Название	Описание
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	Ответ сервера рекламодателя

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

Параметры

HTTP-метод	Права доступа	URL	Примечание
GET	broker_application	https://api.admitad.com/broker/campaign_settings/{c_id}/	Список обязательных полей заявки и их валидация, гдe с_id — идентификатор партнерской программы*

* Возвращает результат в формате 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-сервера

Название	Описание
field_name	Список параметров для запроса
regexp	Регулярное выражение для валидации, если пустое — валидируется дефолтным значением из списка
required	Обязательность
description	Подробное описание