Download OpenAPI specification:Download
Публичные методы Jump.Finance для такси
В каждом запросе должны быть следующие заголовки:
Accept: application/json
Content-Type: application/json
Для авторизации необходимо передать ключ клиента.
Ключ можно передать двумя способами:
Client-Key
client_key
Получить значение для ключа можно в личном кабинете
Используется в методах:
[- {
- "value": 1,
- "title": "Банковский счет"
}, - {
- "value": 2,
- "title": "Банковская карта по номеру телефона"
}
]
Статусы заявок на регистрацию
[- {
- "value": "draft",
- "title": "Черновик"
}, - {
- "value": "not_filled",
- "title": "Не заполнена"
}, - {
- "value": "exchange_error",
- "title": "Ошибка от агрегатора"
}, - {
- "value": "not_processed",
- "title": "Не обработана"
}, - {
- "value": "register",
- "title": "Регистрируется"
}, - {
- "value": "registered",
- "title": "Зарегистрирована"
}, - {
- "value": "rejected",
- "title": "Отклонена менеджером"
}, - {
- "value": "filled",
- "title": "Регистрируется"
}
]
Статусы заданий на регистрацию заявки в агрегаторах
[- {
- "value": "new",
- "title": "Создана"
}, - {
- "value": "exchange_error",
- "title": "Ошибка от агрегатора"
}, - {
- "value": "register",
- "title": "Регистрируется"
}, - {
- "value": "registered",
- "title": "Зарегистрирована"
}, - {
- "value": "rejected",
- "title": "Отклонена менеджером"
}
]
Загружаемые документы
Для таксистов и авто курьеров доступны все типы, для пеших курьеров только 3, 4 и 5
Доступность документов определяется по обязательному параметру profession_id
profession_id required | integer Example: profession_id=1 ID профессии |
[- {
- "name": 1,
- "title": "Водительское удостоверение"
}, - {
- "name": 2,
- "title": "СТС"
}, - {
- "name": 3,
- "title": "Разворот паспорта"
}, - {
- "name": 4,
- "title": "Страница прописки в паспорте"
}, - {
- "name": 5,
- "title": "Селфи с паспортом"
}, - {
- "name": 6,
- "title": "Водительское удостоверение (обратная сторона)"
}, - {
- "name": 7,
- "title": "СТС (обратная сторона)"
}
]
Модули (шаги) для заполнения полной формы
Кем будете работать?
- выбор направления регистрации
У вас есть авто?
- наличие авто, недоступен при указании в форме регистрации только пеших курьеров
Как будете доставлять?
- доступен только для курьеров, шаг определяет направление пешего или авто курьера
Агрегаторы для работы
- доступны указанные в форме диспетчерские
О себе
- для водителей есть поле разрешения на работу в такси, для пеших курьеров есть поле даты рождения
Водительское удостоверение
- недоступен для пеших курьеров
Данные авто
- недоступен для пеших курьеров и при отсутствии собственного авто
[- {
- "value": "profession",
- "title": "Кем будете работать?"
}, - {
- "value": "is_car_driver",
- "title": "У вас есть авто?"
}, - {
- "value": "courier_type",
- "title": "Как будете доставлять?"
}, - {
- "value": "integrations",
- "title": "Агрегаторы для работы"
}, - {
- "value": "person_info",
- "title": "О себе"
}, - {
- "value": "driver_license",
- "title": "Водительское удостоверение"
}, - {
- "value": "car",
- "title": "Данные авто"
}
]
Тип способа доставки для курьера
1
- На автомобиле
2
- На мотоцикле
3
- На самокате, велосипеде или пешком
[- {
- "title": "На автомобиле",
- "value": 1
}, - {
- "title": "На мотоцикле",
- "value": 2
}, - {
- "title": "На самокате, велосипеде или пешком",
- "value": 3
}
]
Полный список моделей автомобилей
[- {
- "id": 1,
- "title": "Lada Granta",
- "aliases": "гранта",
- "mark": {
- "id": 1,
- "title": "Lada",
- "aliases": "лада"
}
}, - {
- "id": 2,
- "title": "Lada Priora",
- "aliases": "приора",
- "mark": {
- "id": 1,
- "title": "Lada",
- "aliases": "лада"
}
}, - {
- "id": 7,
- "title": "Solaris",
- "aliases": "салярис;солярис;соларис;solris",
- "mark": {
- "id": 3,
- "title": "Hyundai",
- "aliases": "хенд;хёнд;хунд;хюнд;hyndai;huyndai;хуйдай;хуедай;hyidai;hundai;solaris;солярись"
}
}
]
Поиск модели автомобилей с автокомплитом
search required | string >= 2 Example: search=лада Поиск по марке и модели авто |
[- {
- "id": 1,
- "title": "Lada Granta",
- "aliases": "гранта",
- "mark": {
- "id": 1,
- "title": "Lada",
- "aliases": "лада"
}
}, - {
- "id": 2,
- "title": "Lada Priora",
- "aliases": "приора",
- "mark": {
- "id": 1,
- "title": "Lada",
- "aliases": "лада"
}
}, - {
- "id": 7,
- "title": "Solaris",
- "aliases": "салярис;солярис;соларис;solris",
- "mark": {
- "id": 3,
- "title": "Hyundai",
- "aliases": "хенд;хёнд;хунд;хюнд;hyndai;huyndai;хуйдай;хуедай;hyidai;hundai;solaris;солярись"
}
}
]
Если не указан период выборки (параметры period_from и period_to), то данные будут за последние 4 недели.
Сортировка доступна по следующим полям
id
- ID транзакции date
- дата создания транзакции в базе integrations
- название интеграции amount
- сумма транзакцииpage | integer <int64> >= 1 Default: 1 Текущая страница |
per_page | string [ 10 .. 200 ] Default: 20 Enum: 10 20 50 100 200 Количество элементов на странице |
order | string Examples:
Сортировка по полю (-desc, без префикса asc) |
period_from | string <ISO8601> Example: period_from=2023-06-15T10:55:20+03:00 Дата начала периода (включительно) |
period_to | string <ISO8601> Example: period_to=2023-06-15T23:55:20+03:00 Дата окончания периода (включительно) |
integration_ids[] | Array of integers Example: integration_ids[]=1&integration_ids[]=2 Интеграции |
transaction_type_ids[] | Array of integers Example: transaction_type_ids[]=1&transaction_type_ids[]=2 Тип транзакции |
driver_ids[] | Array of integers Example: driver_ids[]=1&driver_ids[]=2 ID водителей |
{- "items": [
- {
- "id": 1536914953,
- "date": "2023-06-15T10:55:20+03:00",
- "description": "Поездка order_82638471 (Поездки – заработок)",
- "driver": {
- "id": 1234,
- "phone": 79999999999,
- "last_name": "Иванов",
- "first_name": "Иван",
- "full_name": "Иванов Иван Иванович",
- "middle_name": "Иванович"
}, - "type": {
- "id": 1,
- "name": "Поездки – заработок"
}, - "integration": {
- "id": 1,
- "name": "Мостакси24"
}, - "amount": 565,
- "payment_id": 1232,
- "trip": {
- "date": "2023-06-15T10:55:20+03:00",
- "address_from": "пр. Ленинский, 127",
- "address_to": "ул. Фрунзе, 21",
- "duration": 2586,
- "distance": 5078,
- "payment_type": {
- "id": 1,
- "name": "Наличные"
}, - "amount": {
- "order": 565,
- "tip": 30,
- "cash": 30,
- "cashless": 565,
- "aggregator_commission": 128.64,
- "customer_commission": 22.6,
- "total": 413.76
}, - "comment": "Данные по поездке могут быть неточными. Обратитесь в Таксовичкоф"
}
}
], - "meta": {
- "total": 6371,
- "from": 1,
- "to": 20,
- "per_page": 20,
- "current_page": 1,
- "last_page": 319
}
}
Получение размера комиссии при списании и проверка возможности совершить операцию
driver_id required | integer Example: 1232 ID водителя |
amount required | number Сумма |
balance_id required | integer ID баланса |
include_commission | boolean or null Default: false Включать комиссию в сумму заявки |
{- "amount": 100.1,
- "balance_id": 1232,
- "include_commission": true
}
{- "data": {
- "is_valid_amount": false,
- "error": "Недостаточно средств на счете",
- "commissions": {
- "amount": 400,
- "commission": 20.05,
- "total": 379.95
}
}
}
driver_id required | integer Example: 1232 ID водителя |
operation required | any Enum: "withdraw" "deposit" "transfer" Вид транзакции
|
amount required | number Сумма |
balance_id required | integer ID баланса |
target_balance_id | integer or null ID баланса для получения перевода (обязателен для operation= |
transaction_type_id | integer or null ID типа транзакции (обязателен для operation= |
message | string Комментарий |
create_payment | boolean or null Default: false Создать заявку на выплату |
include_commission | boolean or null Default: false Включать комиссию в сумму заявки |
{- "operation": "withdraw",
- "transaction_type_id": 14,
- "balance_id": 14095751,
- "amount": 100,
- "message": "Тест списания",
- "create_payment": true,
- "include_commission": true
}
{- "error": {
- "title": "Ошибка авторизации",
- "detail": "Требуется авторизация",
- "fields": null,
- "code": 401
}
}
Сортировка доступна по следующим полям
id
- ID водителяgroup_id
- ID группыinvited_by
- ID пригласившего водителяbalance
- по суммарному значению балансаpage | integer <int64> >= 1 Default: 1 Текущая страница |
per_page | string [ 10 .. 200 ] Default: 20 Enum: 10 20 50 100 200 Количество элементов на странице |
order | string Examples:
Сортировка по полю (-desc, без префикса asc) |
integration_ids[] | Array of integers Example: integration_ids[]=1&integration_ids[]=2 Интеграции |
group_ids[] | Array of integers Example: group_ids[]=1&group_ids[]=2 Группы |
anti_fraud_status_ids[] | Array of integers Example: anti_fraud_status_ids[]=1&anti_fraud_status_ids[]=2 Статусы анти-фрода |
referrer_ids[] | Array of integers Example: referrer_ids[]=1&referrer_ids[]=2 ID пригласивших водителей |
search | string Examples:
Поиск по ID в системе, ID в агрегаторе, ФИО, номеру телефона |
{- "items": [
- {
- "id": 1234,
- "phone": 79999999999,
- "last_name": "Иванов",
- "first_name": "Иван",
- "middle_name": "Иванович",
- "full_name": "Иванов Иван Иванович",
- "tooltip": [
- "У водителя есть изменения в реквизитах"
], - "balance": 100.5,
- "group": {
- "id": 23,
- "name": "По-умолчанию"
}, - "anti_fraud_status": {
- "id": 1,
- "name": "Вывод разрешен"
}, - "invited_by": {
- "id": 1234,
- "phone": 79999999999,
- "last_name": "Иванов",
- "first_name": "Иван",
- "full_name": "Иванов Иван Иванович",
- "middle_name": "Иванович"
}, - "integrations": [
- {
- "id": 1232,
- "name": "Мостакси24"
}
], - "in_blacklist": false,
- "created_at": "2021-01-18T14:16:59+03:00",
- "first_trip_at": "2021-01-18T14:16:59+03:00",
- "last_trip_at": "2021-01-18T14:16:59+03:00"
}
], - "meta": {
- "total": 6371,
- "from": 1,
- "to": 20,
- "per_page": 20,
- "current_page": 1,
- "last_page": 319
}
}
driver_id required | integer Example: 1232 ID водителя |
{- "id": 1232,
- "last_name": "Иванов",
- "first_name": "Иван",
- "second_name": "Иванович",
- "status": 1,
- "anti_fraud_status": {
- "id": 0,
- "name": "string"
}, - "withdrawal_forbidden_comment": "Причина блокировки",
- "withdraw_blocked_until_at": "2022-09-03T10:51:13+03:00",
- "is_withdraw_temporary_blocked": true,
- "phone": 79999999999,
- "agent": {
- "id": 1232,
- "name": "ООО ААА"
}, - "requisites": [
- {
- "id": 1,
- "driver_id": 1232,
- "type_id": 0,
- "account_number": "string",
- "additional": {
- "name": "Реквизит #7",
- "type_id": 7,
- "is_default": true,
- "account_number": "40800001111222215232",
- "bik": "044525225",
- "inn": "0000000000",
- "contract_number": "223344",
- "last_name": "Иванов",
- "first_name": "Иван",
- "middle_name": "Иванович",
- "bank_card_payment_type": "Visa"
}, - "is_default": true,
- "is_removed": false,
- "name": "Основной реквизит",
- "driver_change_date": "2022-09-03T10:51:13+03:00",
- "card": {
- "uuid": "550e8400-e29b-41d4-a716-446655440000"
}
}
], - "allow_types": [
- {
- "id": 10,
- "title": "Карта банка по номеру телефона",
- "slug": "bank_card_by_phone"
}
], - "group": {
- "id": 23,
- "name": "По-умолчанию"
}, - "park_note": "Примечание",
- "park_comment": "Финансовый комментарий",
- "referrer_id": 2345,
- "invitation_date": "2022-09-03T10:51:13+03:00",
- "inn": null,
- "license": null,
- "contract": {
- "agreements": [
- {
- "id": 0,
- "name": "string",
- "date": "2022-09-03T10:51:13+03:00",
- "is_archival": false,
- "agent": {
- "id": 1232,
- "name": "ООО ААА"
}
}
], - "contract_number": 1232,
- "contract_signed_at": "2022-09-03T10:51:13+03:00",
- "contract_full_name": "Иванов Иван Иванович",
- "email": "ivanov@test.com",
- "passport_number": 3131313131,
- "passport_issue_date": "2022-09-03T10:51:13+03:00"
}, - "vehicle": {
- "vehicle_id": 1232,
- "car_license_number": 1231232,
- "car_number": "А123АА777",
- "mark": "Ford",
- "model": "Focus",
- "color": "Белый"
}, - "cards": [
- {
- "id": 1232,
- "card_type_id": 123456,
- "balance_type_id": 123456,
- "balance_name": "Реферальные бонусы",
- "card_number": "Яндекс Такси",
- "balance": 111.05,
- "balance_frozen": 3.15,
- "balance_update_time": "2022-09-03T10:51:13+03:00",
- "title": null,
- "name": "YandexTaxometer",
- "name_ru": "Яндекс Такси",
- "color_hex": "FFFFFF",
- "is_internal": true,
- "is_aggregator": false,
- "exchange": {
- "id": 1232,
- "name": "Интеграция по-умолчанию",
- "external_id": "ce9c011f9baec2",
- "driver_url": null
}
}
], - "black_list": {
- "status": false,
- "comment": "Вывод средств запрещен. Водитель внесен в черный список. Для удаления из списка свяжитесь с поддержкой"
}, - "created_at": "2021-01-18T14:16:59+03:00",
- "first_trip_at": "2021-01-18T14:16:59+03:00",
- "last_trip_at": "2021-01-18T14:16:59+03:00"
}
Для создания, редактирования и удаления реквизитов используется один параметр requisites
.
Возможны следующие ситуации обработки списка реквизитов:
При обновлении существующих реквизитов обновляются только поля name
и is_default
(только если оно true
),
driver_id required | integer Example: 1232 ID водителя |
phone | string Номер телефона (со знаком +) не обязателен только если у пользователя нет прав на редактирование номера телефона |
group_id required | integer ID группы |
anti_fraud_status_id required | integer ID статуса анти-фрода |
referrer_id | integer ID пригласившего водителя, если явно указать null, то связь оборвется |
last_name required | string Фамилия |
first_name required | string Имя |
middle_name | string Отчество |
license | string Номер водительского удостоверения |
string | |
withdrawal_forbidden_comment | string Комментарий блокировки списаний |
park_note | string Финансовый комментарий парка |
park_comment | string Комментарий парка |
inn | string <ИНН> ИНН |
contract_number | string Номер архивного договора |
contract_full_name | string ФИО подписанта архивного договора |
contract_signed_at | string <ISO8601> Дата подписания архивного договора |
passport_number | string Номер паспорта в архивном договоре |
passport_issue_date | string <ISO8601> Дата выдачи паспорта в архивном договоре |
enable_car_sync | boolean Разрешить синхронизацию автомобиля |
car_number | string Номер автомобиля |
car_license_number | string Номер разрешения на такси |
Array of objects Набор реквизитов водителя |
{- "phone": 79999999999,
- "group_id": 1,
- "anti_fraud_status_id": 1,
- "referrer_id": 1233,
- "last_name": "Иванов",
- "first_name": "Иван",
- "middle_name": "Иванович",
- "license": 1122334455,
- "email": "ivanov@test.com",
- "withdrawal_forbidden_comment": "",
- "park_note": "",
- "park_comment": "",
- "inn": "",
- "contract_number": 123,
- "contract_full_name": "Иванов Иван Иванович",
- "contract_signed_at": "2022-09-03T10:51:13+03:00",
- "passport_number": 3131313131,
- "passport_issue_date": "2022-09-03T10:51:13+03:00",
- "enable_car_sync": false,
- "car_number": "А123АА777",
- "car_license_number": 1,
- "requisites": [
- {
- "type_id": 0,
- "name": "Основная карта",
- "is_default": true,
- "account_number": "string",
- "bik": 44525225,
- "payment_text": "Перевод собственных средств",
- "sbp_bank_id": 100000000004,
- "inn": 0,
- "last_name": "Иванов",
- "first_name": "Иван",
- "middle_name": "Иванович",
- "contract_number": 223344,
- "card": {
- "uuid": "550e8400-e29b-41d4-a716-446655440000"
}
}
]
}
{- "error": {
- "title": "Ошибка авторизации",
- "detail": "Требуется авторизация",
- "fields": null,
- "code": 401
}
}
Если не указан период выборки (параметры period_from и period_to), то данные будут за последние 4 недели.
Сортировка доступна по следующим полям
id
- ID платежа created_at
- дата созданияupdated_at
- дата измененияrequest_type
- ID типа запросаamount
- сумма платежаamount_paid
- сумма к выплатеpayment_type
- имя счета списанияaggregators
- имя интеграцииpage | integer <int64> >= 1 Default: 1 Текущая страница |
per_page | string [ 10 .. 200 ] Default: 20 Enum: 10 20 50 100 200 Количество элементов на странице |
order | string Examples:
Сортировка по полю (-desc, без префикса asc) |
period_from | string <ISO8601> Example: period_from=2023-06-15T10:55:20+03:00 Дата начала периода (включительно) |
period_to | string <ISO8601> Example: period_to=2023-06-15T23:55:20+03:00 Дата окончания периода (включительно) |
agent_ids | string Example: agent_ids=1,2 ID юридических лиц, строкой через запятую |
driver_ids | string Example: driver_ids=1,2 ID водителей, строкой через запятую |
group_ids | string Example: group_ids=1,2 ID групп водителей, строкой через запятую |
integration_ids | string Example: integration_ids=1,2 ID интеграций, строкой через запятую |
payment_status_id | string Example: payment_status_id=1,2 ID статусов платежа, строкой через запятую |
pay_type_ids | string Example: pay_type_ids=1,2 ID способов оплаты, строкой через запятую |
request_type_ids | string Example: request_type_ids=1,2 ID источника создания выплаты, строкой через запятую |
search | string Examples:
Поиск по ID платежа в системе, ФИО водителя, номеру телефона водителя |
{- "items": [
- {
- "id": 1,
- "created_at": "2021-01-18T14:16:59+03:00",
- "driver": {
- "id": 1234,
- "phone": 79999999999,
- "last_name": "Иванов",
- "first_name": "Иван",
- "full_name": "Иванов Иван Иванович",
- "second_name": "Иванович",
- "group": {
- "id": 23,
- "name": "По-умолчанию"
}
}, - "status": {
- "id": 1,
- "title": "Ошибка выплаты",
- "theme": "danger"
}, - "amount": 312.23,
- "amount_paid": 312,
- "paid_at": "2021-01-18T14:16:59+03:00",
- "pay_type": {
- "id": 10,
- "title": "Банковская карта по номеру телефона"
}, - "integration": {
- "id": 1232,
- "name": "Мостакси24"
}, - "request_type": {
- "id": 3,
- "title": "Автоматическая заявка по периоду"
}, - "agent": {
- "id": 1232,
- "name": "ООО ААА"
}, - "aggregator": {
- "id": 1232,
- "title": "Внутренний баланс"
}, - "commission": 0.23,
- "commission_bank": 0,
- "bank_account": {
- "id": 1232,
- "name": "Счет 1337",
- "balance": 0,
- "is_default": false,
- "payment_types": [
- {
- "id": 26,
- "slug": "Tinkoff SBP",
- "title": "Банковская карта по номеру телефона"
}
], - "agent": {
- "id": 1232,
- "name": "ООО ААА"
}
}, - "requisites": {
- "id": 1232,
- "title": 79999999999
}, - "write_off_account": {
- "id": 1233,
- "title": 79998888888
}, - "history": [
- {
- "date_time": "2021-01-18T14:16:59+03:00",
- "action": "Ошибка: Ошибка запроса: Не удалось инициализировать платежную сессию: Терминал не найден."
}
]
}
], - "meta": {
- "total": 6371,
- "from": 1,
- "to": 20,
- "per_page": 20,
- "current_page": 1,
- "last_page": 319
}
}
Доступные поля для сортировки
direction[] | Array of strings Items Enum: "taxi" "auto_courier" "walking_courier" "undefined" Массив направлений регистрации (Такси, Курьеры авто/мото, Пешие курьеры) |
search | string Поиск по ФИО и телефону водителя |
status[] | Array of strings Items Enum: "draft" "not_filled" "exchange_error" "not_processed" "register" "registered" "rejected" "filled" Массив статусов заявок на регистрацию |
page | integer <int64> >= 1 Default: 1 Текущая страница |
per_page | string [ 10 .. 200 ] Default: 20 Enum: 10 20 50 100 200 Количество элементов на странице |
order | string Examples:
Сортировка по полю (-desc, без префикса asc) |
{- "items": [
- {
- "id": 1,
- "date": "2023-06-15T10:55:20+03:00",
- "name": "Сидорова Алиса Сергеевна",
- "phone": "+79000000000",
- "direction": {
- "id": 1,
- "slug": "taxi",
- "name": "Такси"
}, - "status": {
- "id": 2,
- "slug": "register",
- "title": "В процессе регистрации"
}, - "comment": "Что-то пошло не так...",
- "referrer": "2222",
- "managers": [
- "Константинопольский К.К."
]
}
], - "meta": {
- "total": 6371,
- "from": 1,
- "to": 20,
- "per_page": 50,
- "current_page": 1,
- "last_page": 319
}, - "links": {
- "path": "string",
- "first_page_url": "string",
- "last_page_url": "string",
- "next_page_url": "string",
- "prev_page_url": "string"
}
}
Пакетное отклонение заявок
direction[] | Array of strings Items Enum: "taxi" "auto_courier" "walking_courier" "undefined" Массив направлений регистрации (Такси, Курьеры авто/мото, Пешие курьеры) |
search | string Поиск по ФИО и телефону водителя |
status[] | Array of strings Items Enum: "draft" "not_filled" "exchange_error" "not_processed" "register" "registered" "rejected" "filled" Массив статусов заявок на регистрацию |
is_all required | boolean Применить ко всем заявкам с учетом фильтра
|
ids | Array of integers or null Применить только к выбранным заявкам (смотреть описание is_all) |
comment required | string <= 500 characters Причина отклонения |
new_status required | string Value: "reject" Новый статус заявки |
{- "is_all": false,
- "ids": [
- 1,
- 2,
- 3
], - "comment": "Причина отклонения",
- "new_status": "reject"
}
{- "error": {
- "title": "Неверный запрос",
- "detail": "Неверный запрос.",
- "fields": null,
- "code": 400
}
}
Получить количество заявок по статусам
direction[] | Array of strings Items Enum: "taxi" "auto_courier" "walking_courier" "undefined" Массив направлений регистрации (Такси, Курьеры авто/мото, Пешие курьеры) |
search | string Поиск по ФИО и телефону водителя |
status[] | Array of strings Items Enum: "draft" "not_filled" "exchange_error" "not_processed" "register" "registered" "rejected" "filled" Массив статусов заявок на регистрацию |
{- "data": {
- "not_filled": 1,
- "exchange_error": 2,
- "not_processed": 3,
- "register": 4,
- "registered": 5,
- "rejected": 6
}
}
Получить данные заявки на регистрацию
application_id required | integer Example: 1 ID заявки на регистрацию |
{- "item": {
- "id": 1,
- "phone": "+79999999999",
- "direction": {
- "id": 1,
- "slug": "drivers",
- "title": "Такси"
}, - "profession": {
- "id": 1,
- "name": "Курьер"
}, - "person_info": {
- "last_name": "Иванов",
- "first_name": "Иван",
- "middle_name": "Иванович",
- "birthdate": "2023-03-28",
- "city": "Москва",
- "driver_license_taxi": 4444444,
- "files": [
- {
- "type_id": 3,
- "size": 12345,
- "type": "png"
}, - {
- "type_id": 4,
- "size": 12345,
- "type": "png"
}, - {
- "type_id": 5,
- "size": 12345,
- "type": "png"
}
], - "comment": "Комментарий пользователя"
}, - "is_car_driver": true,
- "is_moto_courier": false,
- "date": "2023-03-11T13:20:30+03:00",
- "driver_license": {
- "country": {
- "value": 100,
- "title": "Россия"
}, - "number": "1234567890",
- "issue_date": "2023-03-28",
- "expiry_date": "2033-03-28",
- "expiry_date_unlimited": false,
- "total_since_date": "2023-03-28",
- "files": [
- {
- "type_id": 1,
- "size": 12345,
- "type": "png"
}, - {
- "type_id": 1,
- "size": 12345,
- "type": "png"
}
]
}, - "car": {
- "model": {
- "id": 1,
- "name": "Hyundai Solaris"
}, - "color": {
- "id": 1,
- "name": "белый"
}, - "year": 2022,
- "number": "а000аа000",
- "license": "00АА000000",
- "vin": "А00000000А0000000",
- "no_vin": false,
- "files": [
- {
- "type_id": 2,
- "size": 12345,
- "type": "png"
}, - {
- "type_id": 2,
- "size": 12345,
- "type": "png"
}
]
}, - "status": {
- "id": 2,
- "slug": "register",
- "title": "В процессе регистрации"
}, - "integrations": [
- {
- "aggregator_id": 6,
- "name": "Яндекс.Про",
- "application_integrations": [
- {
- "id": 2,
- "integration_id": 6,
- "name": "Новосибирск",
- "manager": {
- "id": 123,
- "name": "Константинопольский К.К."
}, - "status": {
- "id": 4,
- "slug": "exchange_error",
- "name": "Ошибка от агрегатора"
}, - "comment": "Текст причины отклонения от агрегатора",
- "group": {
- "id": 23,
- "name": "По умолчанию"
}
}
]
}
], - "is_editable": [
- "integrations"
], - "referrer": "2222",
- "history": [
- {
- "id": 123,
- "name": "Константинопольский К.К.",
- "changes": [
- {
- "integrations": [
- {
- "aggregator_id": 6,
- "application_integrations": [
- {
- "id": 16,
- "integration_id": 6,
- "status": {
- "id": 4,
- "name": "В процессе регистрации"
}
}
], - "comment": "Текст причины отклонения от агрегатора"
}
]
}
]
}
]
}
}
application_id required | integer Example: 1 ID заявки на регистрацию |
profession | integer ID профессии |
{- "profession": 1
}
{- "item": {
- "id": 1,
- "phone": "+79999999999",
- "direction": {
- "id": 1,
- "slug": "drivers",
- "title": "Такси"
}, - "profession": {
- "id": 1,
- "name": "Курьер"
}, - "person_info": {
- "last_name": "Иванов",
- "first_name": "Иван",
- "middle_name": "Иванович",
- "birthdate": "2023-03-28",
- "city": "Москва",
- "driver_license_taxi": 4444444,
- "files": [
- {
- "type_id": 3,
- "size": 12345,
- "type": "png"
}, - {
- "type_id": 4,
- "size": 12345,
- "type": "png"
}, - {
- "type_id": 5,
- "size": 12345,
- "type": "png"
}
], - "comment": "Комментарий пользователя"
}, - "is_car_driver": true,
- "is_moto_courier": false,
- "date": "2023-03-11T13:20:30+03:00",
- "driver_license": {
- "country": {
- "value": 100,
- "title": "Россия"
}, - "number": "1234567890",
- "issue_date": "2023-03-28",
- "expiry_date": "2033-03-28",
- "expiry_date_unlimited": false,
- "total_since_date": "2023-03-28",
- "files": [
- {
- "type_id": 1,
- "size": 12345,
- "type": "png"
}, - {
- "type_id": 1,
- "size": 12345,
- "type": "png"
}
]
}, - "car": {
- "model": {
- "id": 1,
- "name": "Hyundai Solaris"
}, - "color": {
- "id": 1,
- "name": "белый"
}, - "year": 2022,
- "number": "а000аа000",
- "license": "00АА000000",
- "vin": "А00000000А0000000",
- "no_vin": false,
- "files": [
- {
- "type_id": 2,
- "size": 12345,
- "type": "png"
}, - {
- "type_id": 2,
- "size": 12345,
- "type": "png"
}
]
}, - "status": {
- "id": 2,
- "slug": "register",
- "title": "В процессе регистрации"
}, - "integrations": [
- {
- "aggregator_id": 6,
- "name": "Яндекс.Про",
- "application_integrations": [
- {
- "id": 2,
- "integration_id": 6,
- "name": "Новосибирск",
- "manager": {
- "id": 123,
- "name": "Константинопольский К.К."
}, - "status": {
- "id": 4,
- "slug": "exchange_error",
- "name": "Ошибка от агрегатора"
}, - "comment": "Текст причины отклонения от агрегатора",
- "group": {
- "id": 23,
- "name": "По умолчанию"
}
}
]
}
], - "is_editable": [
- "integrations"
], - "referrer": "2222",
- "history": [
- {
- "id": 123,
- "name": "Константинопольский К.К.",
- "changes": [
- {
- "integrations": [
- {
- "aggregator_id": 6,
- "application_integrations": [
- {
- "id": 16,
- "integration_id": 6,
- "status": {
- "id": 4,
- "name": "В процессе регистрации"
}
}
], - "comment": "Текст причины отклонения от агрегатора"
}
]
}
]
}
]
}
}
application_id required | integer Example: 1 ID заявки на регистрацию |
comment | string <= 500 characters Причина отклонения |
{- "comment": "Причина отклонения"
}
{- "error": {
- "title": "Ошибка авторизации",
- "detail": "Требуется авторизация",
- "fields": null,
- "code": 401
}
}
application_id required | integer Example: 1 ID заявки на регистрацию |
integration_id | integer ID интеграции
Значение |
{- "integration_id": 111
}
{- "data": {
- "application_integration_id": 111
}
}
application_id required | integer Example: 1 ID заявки на регистрацию |
application_integration_id required | integer Example: 1 ID регистрации пользователя через конкретную интеграцию |
{- "item": {
- "aggregator_id": 6,
- "name": "Яндекс.Про",
- "application_integrations": [
- {
- "id": 2,
- "integration_id": 6,
- "name": "Новосибирск",
- "manager": {
- "id": 123,
- "name": "Константинопольский К.К."
}, - "status": {
- "id": 4,
- "slug": "exchange_error",
- "name": "Ошибка от агрегатора"
}, - "comment": "Текст причины отклонения от агрегатора",
- "group": {
- "id": 23,
- "name": "По умолчанию"
}
}
]
}
}
application_id required | integer Example: 1 ID заявки на регистрацию |
application_integration_id required | integer Example: 1 ID регистрации пользователя через конкретную интеграцию |
{- "error": {
- "title": "Ошибка авторизации",
- "detail": "Требуется авторизация",
- "fields": null,
- "code": 401
}
}
application_id required | integer Example: 1 ID заявки на регистрацию |
application_integration_id required | integer Example: 1 ID регистрации пользователя через конкретную интеграцию |
comment | string <= 500 characters Причина отклонения |
{- "comment": "Причина отклонения"
}
{- "error": {
- "title": "Ошибка авторизации",
- "detail": "Требуется авторизация",
- "fields": null,
- "code": 401
}
}
application_id required | integer Example: 1 ID заявки на регистрацию |
file required | string <binary> |
{- "data": {
- "id": 1,
- "size": 12345,
- "type": "png"
}
}
application_id required | integer Example: 1 ID заявки на регистрацию |
file_id required | integer Example: 1 ID файла для скачивания |
{- "error": {
- "title": "Ошибка авторизации",
- "detail": "Требуется авторизация",
- "fields": null,
- "code": 401
}
}
Создать подписку на события изменения заявок
url required | string Ссылка на обработчик запроса со стороны клиента |
method required | string Http метод, через который нужно отправлять запрос, по умолчанию post |
token required | string API токен, с которым будут выполняться запросы |
{- "method": "POST",
- "token": "ba7d29f5255c48ed99501ae6ecc49e1e"
}
{- "data": {
- "webhook_id": 1
}
}
{- "action": "new_application",
- "item": {
- "id": 1,
- "phone": "+79999999999"
}, - "updated_at": "2023-03-11T13:20:30+03:00"
}
Получение данных подписки на события изменения заявок
webhook_id required | integer Example: 1 ID подписки на события |
{- "item": {
- "id": 1,
- "method": "POST",
- "token": "ba7d29f5255c48ed99501ae6ecc49e1e"
}
}
webhook_id required | integer Example: 1 ID подписки на события |
url | string Ссылка на обработчик запроса со стороны клиента |
{- "token": "ba7d29f5255c48ed99501ae6ecc49e1e",
- "method": "POST"
}
{- "error": {
- "title": "Ошибка авторизации",
- "detail": "Требуется авторизация",
- "fields": null,
- "code": 401
}
}
webhook_id required | integer Example: 1 ID подписки на события |
{- "error": {
- "title": "Ошибка авторизации",
- "detail": "Требуется авторизация",
- "fields": null,
- "code": 401
}
}