Документация API
Для доступа к API необходимо получить токен и ID вебмастера у администратора.
Адрес: https://api.devtek.ru/new-lead/
Метод: POST
Формат данных: JSON
Для работы с API вы можете воспользоваться SDK. Скачать его можно на гитхабе: https://github.com/devtek-io/php-sdk.
| Секция | Поле | Тип поля | Формат | Обязательное | Описание |
| id_webmaster | integer() | да | Id вебмастера | ||
| token | string(32) | да | Токен для доступа к API | ||
| data/main | last_name |
string (255)
|
Да |
Фамилия |
|
| data/main | first_name |
string (255)
|
Да |
Имя |
|
| data/main | middle_name |
string (255)
|
Да |
Отчество |
|
| data/main | birthday |
date (255)
|
Да |
Дата рождения |
|
| data/main | phone |
string (255)
|
+79xxxxxxxxx | Да |
Номер телефона |
| data/main |
string (255)
|
Email |
|||
| data/main | kladr |
string (13)
|
Да |
КЛАДР Города выдачи кредита |
|
| data/main | amount |
number (10)
|
\d+ | Да |
Сумма кредита |
| data/main | credit_history |
enum (1)
|
\d |
Кредитная история
1 - Никогда не брал кредитов 2 - Никогда не допускал просрочек 3 - Закрытые просрочки 4 - Текущие просрочки 5 - Работают коллекторы |
|
| data/main | sopd_date |
date (255)
|
Дата и время оставления клиентом заявки |
||
| data/main | sopd_site |
string (255)
|
Сайт, на котором была оставлена заявка |
||
| data/main | sopd_general |
string (255)
|
СОПД_общее. (Ссылка на версию СОПД действующую в момент получения согласия на обработку перс данных) |
||
| data/main | sopd_signed |
string (255)
|
СОПД_подписанное. Ссылка на pdf файл (документ в формате pdf с данными клиента СОПД) |
||
| data/main | channel |
integer | string(255) (255)
|
Канал |
||
| data/main | sub_id1 |
integer | string(255) (255)
|
Дополнительное поле для разметки трафика |
||
| data/main | sub_id2 |
integer | string(255) (255)
|
Дополнительное поле для разметки трафика |
||
| data/main | sub_id3 |
integer | string(255) (255)
|
Дополнительное поле для разметки трафика |
||
| data/main | sub_id4 |
integer | string(255) (255)
|
Дополнительное поле для разметки трафика |
||
| data/main | sub_id5 |
integer | string(255) (255)
|
Дополнительное поле для разметки трафика |
||
| data/detailed | passport_series |
string (255)
|
\d{4} |
Серия паспорта |
|
| data/detailed | passport_number |
string (255)
|
\d{6} |
Номер паспорта |
|
| data/detailed | passport_issued_date |
string (255)
|
Дата выдачи паспорта |
||
| data/detailed | passport_issued |
string (255)
|
Место выдачи паспорта |
||
| data/detailed | passport_issued_code |
string (255)
|
\d{4}-\d{4} |
Код подразделения, выдавшего паспорт |
|
| data/detailed | registration_region |
string (255)
|
Регион регистрации |
||
| data/detailed | registration_city |
string (255)
|
Город регистрации |
||
| data/detailed | registration_index |
string (255)
|
Индекс регистрации |
||
| data/detailed | registration_street |
string (255)
|
Улица регистрации |
||
| data/detailed | registration_street_kladr |
string (255)
|
КЛАДР улицы регистрации |
||
| data/detailed | registration_city_kladr |
string (255)
|
КЛАДР города регистрации |
||
| data/detailed | registration_region_kladr |
string (255)
|
КЛАДР региона регистрации |
||
| data/detailed | registration_house |
string (255)
|
Дом регистрации |
||
| data/detailed | registration_house_kladr |
string (255)
|
КЛАДР дома регистрации |
||
| data/detailed | registration_housing |
string (255)
|
Корпус регистрации |
||
| data/detailed | registration_housing_kladr |
string (255)
|
КЛАДР корпус регистрации |
||
| data/detailed | registration_apartment |
string (255)
|
Квартира регистрации |
||
| data/detailed | deposit |
enum (1)
|
\d |
Залог
1 - Нет залога 2 - Автомобиль 3 - Квартира 4 - Дом 5 - Участок 6 - Иное транспортное средство 7 - Бизнес 8 - Есть, но не указано какой именно |
|
| data/job | region |
string (255)
|
Регион работы |
||
| data/job | city |
string (255)
|
Город работы |
||
| data/job | street |
string (255)
|
Улица работы |
||
| data/job | house |
string (255)
|
Дом работы |
||
| data/job | housing |
string (255)
|
Корпус работы |
||
| data/job | region_kladr |
string (255)
|
КЛАДР региона работы |
||
| data/job | city_kladr |
string (255)
|
КЛАДР города работы |
||
| data/job | street_kladr |
string (255)
|
КЛАДР улицы работы |
||
| data/job | place |
string (255)
|
Место работы |
||
| data/job | monthly_income |
number (10)
|
Ежемесячный доход |
||
| data/job | experience |
number (10)
|
Опыт работы (месяцев) |
||
| data/job | phone |
string (12)
|
+79xxxxxxxxx |
Рабочий телефон |
|
| data/job | employment |
enum ()
|
\d |
Тип трудоустройства
1 - По трудовому договору 2 - Владелец бизнеса 3 - ИП (ИЧП, ПБОЮЛ) 4 - Постоянная работа по договору найма 5 - Государственный служащий 6 - Не трудоустроен 7 - Учусь 8 - Пенсионер 9 - Иной источник постоянного дохода |
|
| data/job | position |
string (255)
|
\w+ |
Должность |
Пример тела запроса
{
"id_webmaster": 123,
"token": "4tweTt6hsdfheyhsdrah5df45oIs7YnH",
"data": {
"main": {
"phone": "+79270001122",
"last_name": "Иванов",
"first_name": "Иван",
"middle_name": "Иванович",
"birthday": "03.11.1994",
"email": "[email protected]",
"kladr": "7700000000000",
"amount": 50000,
"credit_history": 1,
"channel": "test"
},
"detailed": {
"passport_series": "1122",
"passport_number": "111222",
"passport_issued_date": "09.12.2008",
"passport_issued": "Отделом 1 УФМС России по Тюменской области в Ленинском АО города Тюмени ",
"passport_issued_code": "720-001",
"registration_region": "Тюменская обл ",
"registration_city": "Тюмень",
"registration_index": "625027",
"registration_street": "ул 50 лет Октября",
"registration_street_kladr": "72000001000024100",
"registration_city_kladr": "7200000100000",
"registration_region_kladr": "7200000000000",
"registration_house": "1",
"registration_house_kladr": null,
"registration_housing": null,
"registration_housing_kladr": null,
"registration_apartment": null
},
"job": {
"region": "Тюменская область",
"city": "Тюмень",
"street": "Московская",
"house": "1",
"housing": null,
"region_kladr": null,
"city_kladr": null,
"street_kladr": null,
"place": "Рога и копыта",
"monthly_income": 30000,
"experience": 13,
"phone": "+79294561212",
"employment": 1,
"position": "Администратор"
}
}
}
Пример положительного ответа
{
"result": "ok",
"data": {
"id_lead": 999999
},
"errors": []
}
Пример отрицательного ответа
{
"result": "bad",
"data": [],
"errors": [
"Field \"phone\" error: Введите правильный номер телефона"
]
}
Пример ответа о заявке, являющейся дубликатом
{
"result": "bad",
"data": [],
"errors": [
"Lead duplicate"
]
}
Получение списка регионов
Адрес: https://api.devtek.io/get-regions/
Метод: POST
Получение списка городов
При запросе к методу получения списка городов можно передать параметр "regionId" с номером одного из регионов, полученных от метода get-regions
Адрес: https://api.devtek.io/get-cities/
Метод: POST
Пример запроса
{
"regionId": 40
}