Fleet Open API

# Driver Related

# Управление балансом водителей

Функция: просмотр балансов и управление ими, расчет заработка водителей

Метод: POST

URL: /fleet/open-api/drivers/getBalance

Запрашиваемые параметры:

Параметр Тип Требуется или нет Описание
fleet_id int64 Да Таксопарк ID
driver_id int64 Да Водитель ID
location_country string Да Страна
lang string Да Язык

Возвращаемые параметры:

Параметр Тип Описание
driver_balance string Баланс водителя
currency_code string Код валюты

Пример возврата:

Стандартное условие

{
  "errno": 0,
  "msg": "success",
  "data": {
    "response": {
      "driver_balance": "-217.01",
      "currency_code": "₽"
    },
    "trace_id": "0a6072d45f3cdd6be61db3f9ffdfc9b0"
  }
}
1
2
3
4
5
6
7
8
9
10
11

Нестандартное условие

{
    "errno": 20002,
    "msg": "the driver does not exist."
}
1
2
3
4

Примечание. «response» в примере возврата — это данные json, полученные путем расшифровки и десериализации

# Управление поездками водителей

Функция: получение списка поездок водителя с таксопарком

Метод: POST

URL: /fleet/open-api/drivers/getOrderList

Запрашиваемые параметры:

Параметр Тип Требуется или нет Описание
fleet_id int64 Да Таксопарк ID
location_country string Да Страна
lang string Да Язык
page int32 Да Номер страницы, диапазон: [1,1000000]
size int32 Да Количество поездок на странице, диапазон: [1,100]
driver_id int64 Нет Водитель ID
driver_phone string Нет Номер телефона
start_time string Нет Время начала принятия запроса, формат времени — ISO8601, например: "2006-01-02T15:04:05-07:00"
end_time string Нет Время окончания принятия запроса, формат времени — ISO8601, например:"2006-01-02T15:04:05-07:00"

Возвращаемые параметры:

Параметр Тип Описание
driver_id int64 Водитель ID
driver_name string Имя водителя
fleet_id int64 Таксопарк ID
driver_phone string Номер телефона водителя
order_id int64 Поездка id
acceptance_time string Время принятия, формат времени — ISO8601
start_at string Место подачи
end_at string Место высадки
order_distance string Расстояние
order_status int32 Статус поездки; значения нумерации: см. приложение «Статус поездки»
order_status_desc string Описание Статус поездки
is_pay int32 платить или нет, 0:Нет 1:Да
pay_type int32 Способ оплаты, Значения нумерации: см. приложение «Способы оплаты»
pay_type_desc string Описание Способ оплаты
total_fee string Общая стоимость
currency_code string Код валюты

Пример возврата:

Стандартное условие

{
  "errno": 0,
  "msg": "success",
  "data": {
    "response": {
      "list": [
        {
          "driver_id": 50000000000000,
          "driver_name": "Тест 50000000000000",
          "fleet_id": 10000000000000,
          "driver_phone": "************",
          "order_id": 80000000000000,
          "acceptance_time": "2021-09-01T00:00:00+08:00",
          "start_at": "*************",
          "end_at": "************",
          "order_distance": "2 808 м",
          "order_status": 1,
          "order_status_desc": "Принят",
          "is_pay": 1,
          "pay_type": 1024,
          "pay_type_desc": "Оплата наличными",
          "total_fee": "478.0",
          "currency_code": "RUB"
        }
      ],
      "count": 1
    },
    "trace_id": "0a6072d45f3cdd6be61db3f9ffdfc9b0"
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

Нестандартное условие

{
    "errno": 20002,
    "msg": "the driver does not exist."
}
1
2
3
4

Примечание. «response» в примере возврата — это данные json, полученные путем расшифровки и десериализации

# Проверка статуса водителя

Функция: проверка возможности добавления в таксопарк по номеру телефона водителя

Метод: POST

URL: /fleet/open-api/drivers/checkDriverExist

Запрашиваемые параметры:

Параметр Тип Требуется или нет Описание
fleet_id int64 Да Таксопарк ID
driver_phone string Да Номер телефона водителя. Формат: код страны + номер телефона, например "+700016****44"
location_country string Да Страна
lang string Да Язык

Возвращаемые параметры:

Параметр Тип Описание
is_exists int32 Указывает, существует ли информация о водителе в системе водителей: 0-Не существует 1-Существует
driver_id int64 Водитель id
driver_name string Имя водителя

Пример возврата:

Стандартное условие

{
  "errno": 0,
  "msg": "success",
  "data": {
    "response": {
      "driver_info": {
        "driver_id": 50000000000000,
        "driver_name": ""
      },
      "is_exists": 1
    },
    "trace_id": "0a6072d45f3cdd6be61db3f9ffdfc9b0"
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

Нестандартное условие

{
    "errno": 10001,
    "msg": "driver phone is empty."
}
1
2
3
4

Примечание. «response» в примере возврата — это данные json, полученные путем расшифровки и десериализации

# Добавление новых водителей

Функция: добавление новых водителей таксопарком-партнером

Предварительное условие: проверка, является ли водитель новым водителем, перед запросом к API. Пользователь может получить статус водителя через API «Проверка статуса водителя». Если значение возвращенного параметра «is_exists» — 0, водитель является новым водителем.

Метод: POST

URL: /fleet/open-api/drivers/bindNewDriver

Запрашиваемые параметры:

Параметр Тип Требуется или нет Описание
fleet_id int64 Да Таксопарк ID
driver_phone string Да Номер телефона водителя. Формат: код страны + номер телефона, например "+700016****44"
driver_info object Да Информация о водителе
identity_info object Да Информация о документе
strategy_info object Да Информация о режиме работы
location_country string Да Страна
lang string Да Язык
uranus_product_id int32 Нет Линейка продуктов; значение по умолчанию — 2), См. приложение «Линейка продуктов», чтобы узнать значения нумерации

driver_info Содержимое объекта:

Параметр Тип Требуется или нет Описание
license_no string Да Сведения о водителе: номер водительского удостоверения
family_name string Да Сведения о водителе: фамилия
given_name string Да Сведения о водителе: имя
father_name string Нет Сведения о водителе: отчество (для России)
license_issue_date string Да Сведения о водителе: дата выдачи водительского удостоверения. Формат даты:2020-01-01
license_valid_date string Да Сведения о водителе: дата окончания срока действия водительского удостоверения. Формат даты:2020-01-01
birthday string Да Сведения о водителе: дата рождения. Формат даты:2020-01-01
license_kind string Да Сведения о водителе: тип водительского удостоверения. Значения нумерации: см. «Типы водительских удостоверений»
license_issue_country string Да Сведения о водителе: страна выдачи водительского удостоверения (сокращение на английском). См. приложение «Английские сокращения названий стран»
driver_special_marks string Нет Сведения о водителе: специальный логотип водителя
area_id int64 Да Сведения о водителе: код города. Предоставляется через API «Получение информации о городах, где запущен сервис»
license_f_img string Да Сведения о водителе: URL-ссылка на фотографию лицевой стороны водительского удостоверения. Для получения ссылки на изображение сначала выполните запрос к API «Загрузка сведений об изображении»
license_b_img string Да Сведения о водителе: URL-ссылка на фотографию тыльной стороны водительского удостоверения. Для получения URL-ссылки на изображение сначала выполните запрос к API «Загрузка сведений об изображении»

Identity_info Содержимое объекта:

Параметр Тип Требуется или нет Описание
identity_type string Да Сведения о документе: тип документа. Значения нумерации: см. приложение «Типы документов»
identity_id string Да Сведения о документе: номер документа
id_valid_date string Да Сведения о документе: срок действия документа. Формат даты:2020-01-01
driver_nationality string Да Сведения о документе: страна выдачи документа
identity_img string Да Сведения о документе: URL-ссылка на фотографию документа. Для получения URL-ссылки на изображение сначала выполните запрос к API «Загрузка сведений об изображении»

strategy_info Содержимое объекта:

Параметр Тип Требуется или нет Описание
amount int64 Нет Удержанная сумма, основанная на стоимости поездки
cap_amount int64 Нет Максимальная сумма комиссии за поездку на процентной основе. Если значение — 0, ограничение не применяется
start_time string Нет Время начала. Если не заполнено, по умолчанию используется текущее время. Формат времени — 2021-10-01
percent int32 Нет Процент вычета за каждую поездку
deduct_type int32 Нет Тип вычета. Значения нумерации: 0- по проценту; 1-по сумме
strategy_type int32 Да Тип режима работы: 0- режим работы поездки; 2- регулярный режим работы
name string Нет Название режима работы. См. приложение «Типы платы по циклично выставляемым счетам»
strategy_fee_type int32 Нет Тип платы. Значения нумерации: см. приложение «Типы платы по циклично выставляемым счетам»
period_type int32 Нет Тип периода выставления счета, только для платы, не связанной с поездками. Значения нумерации: см. приложение «Типы периодов выставления счета»

Пример запроса режима работы по проценту:

[{
    "cap_amount": 2000, 
    "deduct_type": 0, 
    "start_time": "",
    "strategy_type": 0,
    "percent": 18
}
]
1
2
3
4
5
6
7
8

Пример запроса режима работы по сумме:

[{
    "amount": 20, 
    "deduct_type": 1, 
    "start_time": "",
    "strategy_type": 0
}
]
1
2
3
4
5
6
7

Пример запроса регулярного режима работы:

[{
    "name": "Плата за уборку",
    "amount": 10, 
    "start_time": "2021-10-02",
    "period_type": 0,
    "strategy_type": 2,
    "strategy_fee_type": 1002
}
]
1
2
3
4
5
6
7
8
9

Пример запроса:

{
  "fleet_id": 10000000000000,
  "location_country": "RU",
  "lang": "ru-RU",
  "drive_id": 50000000000000,
  "driver_phone": "+700016****44",
  "driver_info": {
    "license_no": "6622573****450081D",
    "family_name": "",
    "given_name": "",
    "father_name": "",
    "license_issue_date": "2017-09-27",
    "license_valid_date": "2027-09-27",
    "birthday": "1995-09-01",
    "license_kind": "B",
    "license_issue_country": "RU",
    "area_id": 7800600,
    "license_f_img": "/upload/rooster20210901/5739e4c49e2d/3569dd813b2",
    "license_b_img": "/upload/rooster20210901/57bae93fda8e9/00239d7b4d"
  },
  "identity_info": {
    "identity_type": "passport",
    "identiy_id": "7765****8865",
    "id_valid_date": "2027-09-01",
    "driver_nationality": "RU",
    "identity_img": "/upload/rooster20210901/57bae93fda8e9/00239d7b4d"
  },
  "strategy_info": [{
    "cap_amount": 2000,
    "deduct_type": 0,
    "start_time": "",
    "strategy_type": 0,
    "percent": 18
  }]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

Пример возврата:

Стандартное условие

{
    "errno": 0,
    "msg": "success"
}
1
2
3
4

Нестандартное условие

{
    "errno": 10001,
    "msg": "parameter error."
}
1
2
3
4

Примечание. «response» в примере возврата — это данные json, полученные путем расшифровки и десериализации

# Добавление зарегистрированных водителей

Функция: добавление существующих водителей таксопарком-партнером

Предварительное условие: проверка, является ли водитель существующим водителем, перед запросом к API. Пользователь может получить статус водителя через API «Проверка статуса водителя». Если значение возвращенного параметра «is_exists» — 1, водитель является существующим водителем.

Метод: POST

URL: /fleet/open-api/drivers/bindOldDriver

Запрашиваемые параметры:

Параметр Тип Требуется или нет Описание
fleet_id int64 Да Таксопарк ID
driver_phone string Да Номер телефона водителя, формат: код страны + номер телефона, например "+700016****44"
strategy_info object Да Список режимов работы
location_country string Да Страна
lang string Да Язык
uranus_product_id int32 Нет Линейка продуктов; значение по умолчанию — 2), См. приложение «Линейка продуктов», чтобы узнать значения нумерации

strategy_info Содержимое объекта:

Параметр Тип Требуется или нет Описание
amount int64 Нет Удержанная сумма, основанная на стоимости поездки
cap_amount int64 Нет Максимальная сумма комиссии за поездку на процентной основе. Если значение — 0, ограничение не применяется
start_time string Нет Время начала. Если не заполнено, по умолчанию используется текущее время ,. Формат времени — 2021-10-01
percent int32 Нет Процент вычета за каждую поездку
deduct_type int32 Нет Тип вычета. Значения нумерации: 0- по проценту; 1- по сумме
strategy_type int32 Да Тип режима работы: 0- режим работы поездки; 2- регулярный режим работы
name string Нет Название режима работы. Значения нумерации: см. приложение «Типы платы по циклично выставляемым счетам»
strategy_fee_type int32 Нет Тип платы. Значения нумерации: см. приложение «Типы платы по циклично выставляемым счетам»
period_type int32 Нет Тип периода выставления счета, только для платы, не связанной с поездками. Значения нумерации: см. приложение «Типы периодов выставления счета»

Пример запроса:

{
  "fleet_id": 10000000000000,
  "drive_id": 50000000000000,
  "location_country": "RU",
  "lang": "ru-RU",
  "driver_phone": "+700016****44",
  "strategy_info": [{
    "cap_amount": 2000,
    "deduct_type": 0,
    "start_time": "",
    "strategy_type": 0,
    "percent": 18
  }]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

Пример возврата:

Стандартное условие

{
    "errno": 0,
    "msg": "success"
}
1
2
3
4

Нестандартное условие

{
    "errno": 20020,
    "msg": "the driver has been bound by other fleet."
}
1
2
3
4

Примечание. «response» в примере возврата — это данные json, полученные путем расшифровки и десериализации

# Удаление водителя

Функция: удаление водителей таксопарком-партнером

Метод: POST

URL: /fleet/open-api/drivers/unbind

Запрашиваемые параметры:

Параметр Тип Требуется или нет Описание
fleet_id int64 Да Таксопарк ID
driver_id int64 Да Водитель ID
location_country string Да Страна
lang string Да Язык
uranus_product_id int32 Нет Линейка продуктов; значение по умолчанию — 2), См. приложение «Линейка продуктов», чтобы узнать значения нумерации

Пример возврата:

Стандартное условие

{
    "errno": 0,
    "msg": "success",
    "data": "",
    "trace_id": "0a6072d45f3cdd6be61db3f9ffdfc9b0"
}
1
2
3
4
5
6

Нестандартное условие

{
    "errno": 20007,
    "msg": "failed to get driver binding relationship.",
    "data": "",
    "trace_id": "0a6072d45f3cd92f5883b3f9e57d0fb0"
}
1
2
3
4
5
6

Примечание. «response» в примере возврата — это данные json, полученные путем расшифровки и десериализации

# Получить информацию об условиях работы водителей

Функция: получение условий работы водителей

Метод: POST

URL: /fleet/open-api/drivers/getWorkCondition

Запрашиваемые параметры:

Параметр Тип Требуется или нет Описание
fleet_id int64 Да Таксопарк ID
driver_id int64 Да Водитель ID
location_country string Да Страна
lang string Да Язык

Возвращаемые параметры:

Параметр Тип Описание
id int64 ID: уникальный для режима работы id
name string Название режима работы
amount int64 Сумма
cap_amount int64 Максимальная сумма комиссии за поездку на процентной основе. Если значение — 0, ограничение не применяется
start_time string Время начала. Формат времени — ISO8601
percent int32 Процент вычета за каждую поездку
deduct_type int32 Тип вычета. Значения нумерации: 0- по проценту; 1- по сумме
strategy_type int32 Тип режима работы: 0- режим работы поездки; 2- регулярный режим работы
strategy_fee_type int32 Тип платы. Значения нумерации: см. приложение «Типы платы по циклично выставляемым счетам»
period_type int32 Тип периода выставления счета, только для платы, не связанной с поездками. Значения нумерации: см. приложение «Типы периодов выставления счета»

Пример возврата:

Стандартное условие

{
  "errno": 0,
  "msg": "success",
  "data": {
    "response": {
      "list":[{
        "id": 2198,
        "cap_amount": 2000,
        "deduct_type": 0,
        "start_time": "2021-10-02T00:00:00+03:00",
        "strategy_type": 0,
        "percent": 18,
        "strategy_fee_type": 0
      }],
      "count": 1
    },
    "trace_id": "0a6072d45f3cdd6be61db3f9ffdfc9b0"
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

Нестандартное условие

{
    "errno": 20002,
    "msg": "the driver does not exist."
}
1
2
3
4

Примечание. «response» в примере возврата — это данные json, полученные путем расшифровки и десериализации

# Обновление условий работы водителей

Функция: обновление режима работы водителей

Метод: POST

URL: /fleet/open-api/drivers/updateWorkCondition

Запрашиваемые параметры:

Параметр Тип Требуется или нет Описание
fleet_id int64 Да Таксопарк ID
driver_id int64 Да Водитель ID
strategy_info object Да Список режимов работы
location_country string Да Страна
lang string Да Язык

strategy_info Содержимое объекта:

Параметр Тип Требуется или нет Описание
id int64 Да ID: уникальный для режима работы id
amount int64 Нет Сумма, удержанная на основе стоимости поездки
cap_amount int64 Нет Максимальная сумма комиссии за поездку на процентной основе. Если значение — 0, ограничение не применяется
start_time string Нет Время начала. Если не заполнено, по умолчанию используется текущее время. Формат времени — 2021-10-01
percent int32 Нет Процент вычета за каждую поездку
deduct_type int32 Нет Тип вычета. Значения нумерации: 0- по проценту; 1- по сумме
strategy_type int32 Да Тип режима работы: 0- режим работы поездки; 2- регулярный режим работы
name string Нет Название режима работы. Значения нумерации: см. приложение «Типы платы по циклично выставляемым счетам»
strategy_fee_type int32 Нет Тип платы. Значения нумерации: см. приложение «Типы платы по циклично выставляемым счетам»
period_type int32 Нет Тип периода выставления счета, только для платы, не связанной с поездками. Значения нумерации: см. приложение «Типы периодов выставления счета»

Пример запроса режима работы по проценту:

{
    "id": 2198,
    "cap_amount": 2000, 
    "deduct_type": 0, 
    "start_time": "",
    "strategy_type": 0,
    "percent": 18
}
1
2
3
4
5
6
7
8

Пример запроса режима работы по сумме:

{
    "id": 2198,
    "amount": 20, 
    "deduct_type": 1, 
    "start_time": "",
    "strategy_type": 0
}
1
2
3
4
5
6
7

Пример запроса регулярного режима работы:

{
    "id": 2198,
    "name": "Плата за уборку",
    "amount": 10, 
    "start_time": "2021-10-02",
    "period_type": 0,
    "strategy_type": 2,
    "strategy_fee_type": 1002
}
1
2
3
4
5
6
7
8
9

Пример запроса:

{
  "fleet_id": 10000000000000,
  "drive_id": 50000000000000,
  "location_country": "RU",
  "lang": "ru-RU",
  "strategy_info": {
    "id": 2198,
    "cap_amount": 2000, 
    "deduct_type": 0, 
    "start_time": "",
    "strategy_type": 0,
    "percent": 18
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

Пример возврата:

Стандартное условие

{
    "errno": 0,
    "msg": "success"
}
1
2
3
4

Нестандартное условие

{
    "errno": 10001,
    "msg": "parameter error."
}
1
2
3
4

Примечание. «response» в примере возврата — это данные json, полученные путем расшифровки и десериализации

# Добавление информации об условиях работы водителей

Функция: добавление условий работы водителей

Метод: POST

URL: /fleet/open-api/drivers/addWorkCondition

Запрашиваемые параметры:

Параметр Тип Требуется или нет Описание
fleet_id int64 Да Таксопарк ID
driver_id int64 Да Водитель ID
strategy_info object Да Список режимов работы
location_country string Да Страна
lang string Да Язык

strategy_info Содержимое объекта:

Параметр Тип Требуется или нет Описание
amount int64 Нет Удержанная сумма, основанная на стоимости поездки
cap_amount int64 Нет Максимальная сумма комиссии за поездку на процентной основе. Если значение — 0, ограничение не применяется
start_time string Нет Время начала. Если не заполнено, по умолчанию используется текущее время. Формат времени — 2021-10-01
percent int32 Нет Процент вычета за каждую поездку
deduct_type int32 Нет Тип вычета. Значения нумерации: 0- по проценту; 1- по сумме
strategy_type int32 Да Тип режима работы: 0- режим работы поездки; 2- регулярный режим работы
name string Нет Название режима работы. Значения нумерации: см. приложение «Типы платы по циклично выставляемым счетам»
strategy_fee_type int32 Нет Тип платы. Значения нумерации: см. приложение «Типы платы по циклично выставляемым счетам»
period_type int32 Нет Тип периода выставления счета, только для платы, не связанной с поездками. Значения нумерации: см. приложение «Типы периодов выставления счета»

Пример запроса режима работы по проценту:

{
    "cap_amount": 2000, 
    "deduct_type": 0, 
    "start_time": "",
    "strategy_type": 0,
    "percent": 18
}
1
2
3
4
5
6
7

Пример запроса режима работы по сумме:

{
    "amount": 20, 
    "deduct_type": 1, 
    "start_time": "",
    "strategy_type": 0
}
1
2
3
4
5
6

Пример запроса регулярного режима работы:

{
  "name": "Плата за уборку",
  "amount": 10,
  "start_time": "2021-10-02",
  "period_type": 0,
  "strategy_type": 2,
  "strategy_fee_type": 1002
}
1
2
3
4
5
6
7
8

Пример запроса:

{
  "fleet_id": 10000000000000,
  "drive_id": 50000000000000,
  "location_country": "RU",
  "lang": "ru-RU",
  "strategy_info": {
    "cap_amount": 2000, 
    "deduct_type": 0, 
    "start_time": "",
    "strategy_type": 0,
    "percent": 18
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

Пример возврата:

Стандартное условие

{
    "errno": 0,
    "msg": "success"
}
1
2
3
4

Нестандартное условие

{
    "errno": 10001,
    "msg": "parameter error."
}
1
2
3
4

Примечание. «response» в примере возврата — это данные json, полученные путем расшифровки и десериализации

# Удаление условий работы водителей

Функция: удаление условий работы водителей

Метод: POST

URL: /fleet/open-api/drivers/delWorkCondition

Запрашиваемые параметры:

Параметр Тип Требуется или нет Описание
fleet_id int64 Да Таксопарк ID
driver_id int64 Да Водитель ID
id int64 Да Идентификатор: уникальный для режима работы id
location_country string Да Страна
lang string Да Язык

Возвращаемые параметры:

Стандартное условие

{
    "errno": 0,
    "msg": "success"
}
1
2
3
4

Нестандартное условие

{
    "errno": 10004,
    "msg": "fleet have no permission for this driver"
}
{
    "errno":-1
    "msg":"order strategy can not be delete"
}
1
2
3
4
5
6
7
8

Примечание. «response» в примере возврата — это данные json, полученные путем расшифровки и десериализации

# Получение сведений о водителе

Функция: получение сведений о водителе; возвращает информацию о водителях в таксопарке (статус = «Добавлено»)

Метод: POST

URL: /fleet/open-api/drivers/getDriverList

Запрашиваемые параметры:

Параметр Тип Требуется или нет Описание
fleet_id int64 Да Таксопарк ID
page int32 Да Номер страницы, диапазон: [1,1000000]
size int32 Да Количество поездок на странице, диапазон: [1,100]
location_country string Да Страна
lang string Да Язык
uranus_product_id int32 Нет Линейка продуктов; значение по умолчанию — 2), См. приложение «Линейка продуктов», чтобы узнать значения нумерации

Описание возвращенных параметров сведений о водителе:

Параметр Тип Описание
driver_id int64 Водитель ID
driver_name string Полное имя водителя
family_name string Фамилия водителя
given_name string Имя водителя
father_name string Отчество водителя
driver_phone string Номер телефона водителя
driver_status int32 Статус водителя. Значения нумерации: см. приложение «Статус водителя»
driver_status_desc string Описание статуса водителя
work_status int32 Рабочий статус. Значения нумерации: См. приложение «Рабочий статус»
work_status_desc int32 Описание рабочего статуса
registration_city string Город регистрации

Описание возвращенных параметров сведений об автомобиле:

Параметр Тип Описание
car_id int64 Автомобиль id
plate_no string Номерной знак
brand_name string Марка автомобиля
car_status string Статус проверки автомобиля. Значения нумерации: см. приложение «Статус проверки автомобиля»

Пример возврата:

Стандартное условие

{
  "errno": 0,
  "msg": "success",
  "data": {
    "response": {
      "list": [{
        "car": [{
          "car_id": 50000000000000,
          "plate_no": "688AZZ15",
          "brand_name": "Hyundai Elantra",
          "car_status": 1
        }],
        "car_count": 1,
        "driver":{
          "driver_id": 50000000000000,
          "driver_name": "Тест 571********786",
          "family_name": "zhang",
          "given_name": "san",
          "father_name": "",
          "driver_phone": "**********",
          "driver_status": 3,
          "driver_status_desc": "Approved",
          "work_status": 1,
          "work_status_desc": "Trip in progress",
          "registration_city": "Пекин"
        }
      }],
      "count": 1
    },
    "trace_id": "0a6072d45f3cdd6be61db3f9ffdfc9b0"
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

Нестандартное условие

{
    "errno": 20002,
    "msg": "the driver does not exist."
}
1
2
3
4

Примечание. «response» в примере возврата — это данные json, полученные путем расшифровки и десериализации

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

Функция: просмотр статистики поездок водителя таксопарком-партнером

Метод: POST

URL: /fleet/open-api/drivers/getOrderSummary

Запрашиваемые параметры:

Параметр Тип Требуется или нет Описание
fleet_id int64 Да Таксопарк ID
driver_id_list object Да Список ID водителей
start_date string Да Дата начала; до трех месяцев назад. Формат времени: ISO8601
end_date string Да Дата окончания; до одного месяца после даты начала. Формат времени: ISO8601
location_country string Да Страна
lang string Да Язык

Возвращаемые параметры:

Параметр Тип Описание
driver_id int64 Водитель ID
driver_name string Имя водителя
fleet_id int64 Таксопарк ID
driver_phone string Номер телефона водителя
online_time float64 Всего часов на линии, округляется до двух знаков после запятой (Единица измерения: часы)
dispatch_orders int64 Получено поездок
acceptance_num int64 Принято поездок
acceptance_rate string Индекс принятия заказов
completion_num int64 Поездок завершено
completion_rate string Индекс выполнения
passenger_cancel_orders int64 Поездки, отмененные клиентами
driver_cancel_orders int64 Поездки отмененные водителем
others_cancel_orders int64 Поездки, отмененные по другим причинам
orders_paid_num int64 Поездок завершено и оплачено
paid_transactions string Общая сумма оплаты завершенных поездок
currency_code string Код валюты

Пример запроса:

{
  "fleet_id": 10000000000000,
  "drive_id_list": [60000000000000,60000000000001],
  "location_country": "RU",
  "lang": "ru-RU",
  "start_date": "2021-01-01T00:00:00+03:00",
  "end_date": "2021-01-30T00:00:00+03:00"
}
1
2
3
4
5
6
7
8

Пример возврата:

Стандартное условие

{
  "errno": 0,
  "msg": "success",
  "data": {
    "response": {
      "detail": [
        {
          "driver_id": 50000000000000,
          "driver_name": "Тест 50000000000000",
          "fleet_id": 10000000000000,
          "driver_phone": "*********",
          "online_time": 68.40,
          "dispatch_orders": 50,
          "acceptance_num": 30,
          "acceptance_rate": "60%",
          "completion_num": 30,
          "completion_rate": "60%",
          "passenger_cancel_orders": 10,
          "driver_cancel_orders": 5,
          "others_cancel_orders": 5,
          "orders_paid_num": 30,
          "paid_transactions": "150.50",
          "trip_distance": "100.01",
          "currency_code": "RUB"
        }
      ],
      "count": 1
    },
    "trace_id": "0a6072d45f3cdd6be61db3f9ffdfc9b0"
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

Нестандартное условие

{
    "errno": 20002,
    "msg": "the driver does not exist."
}
1
2
3
4

Примечание. «response» в примере возврата — это данные json, полученные путем расшифровки и десериализации

← Vehicle Related →