Создание ваучера для корпоративного транспортного средства

Обзор

Метод создания ваучера для корпоративного транспортного средства позволяет быстро зарегистрировать автомобиль в системе с минимальным набором обязательных параметров. При этом для корпоративных транспортных средств не требуется заполнять множество полей, связанных с физическим лицом.

Ссылка на основной метод:

• PostVoucher - создать новый ваучер.

Шаг 1. Получение справочных данных

Для корректного заполнения запроса необходимо получить актуальные идентификаторы из справочников:

1. Получите справочные значения для базовых полей через методы:

• GetInfoCarTypes - типы кузова.
• GetInfoVehicleColors - цвета.
• GetInfoEmissionStandards - экологические стандарты.
• GetInfoFuelTypes - типы топлива.

2. Получите идентификатор марки транспортного средства:

• GetInfoVehicleBrands - описание метода.
• Пример:

curl -X GET "https://dev.api.exodrive.ai/api/v2/Info/vehicleBrands?search=Haval" \
-H "Authorization: Bearer YOUR_TOKEN"

3. Получите идентификатор модели транспортного средства:

• GetInfoVehicleModels - описание метода.
• Пример:

curl -X GET "https://dev.api.exodrive.ai/api/v2/Info/vehicleModels?brand=384&search=Jolion" \
-H "Authorization: Bearer YOUR_TOKEN"

Шаг 2. Подготовка регистрационного номера

Регистрационный номер транспортного средства должен:

• содержать не мнее 5 символов;
• использовать только латинские буквы в верхнем регистре (A-Z) и цифры (0-9);
• не содержать пробелов и специальных символов.

В соответствии с ГОСТ Р 50577-2018, в российских автономерах используются только 12 букв кириллицы, имеющих графические аналоги в латинском алфавите. Это позволяет однозначно преобразовать любой регистрационный номер в латинскую запись.

Замените кириллические символы на латинские аналоги согласно таблице:

Пример:

• Исходный номер: О 697 УС 797.
• Правильная запись: O697YC797.

Шаг 3. Выбор типа контракта

Тип контракта определяет параметры работы системы с устройством и особенности биллинга. Для получения списка доступных вашей организации типов контрактов используйте метод:

• GetInfoContractTypes - типы контрактов.

В названии типа контракта зашифрована информация:

• название вашей организации;
• тип используемого оборудования.

Пример: ООО "Вектор" SCOUT A

Корректный выбор типа контракта критически важен для правильной работы системы. При выборе необходимо учитывать:

• тип используемого оборудования;
• класс транспортного средства;
• особенности использования ТС.

В случае сомнений при выборе типа контракта рекомендуется обратиться в техническую поддержку для консультации.

Шаг 4. Формирование запроса

Подготовьте тело JSON-запроса со следующей структурой:

{
  "client": {
    "companyFlag": 1,
    "lastName": "O697YC797"
  },
  "vehicle": {
    "regNumber": "O697YC797",
    "vin": "XZGRE04AXPA888497", 
    "engineDisplacement": 1497,
    "engineMileage": 1,
    "emissionStandardId": 6,
    "fuelType": 0,
    "driverCategory": 30,
    "modelVehicleId": 8130,
    "carTypeId": 10,
    "colorId": 2,
    "productionYear": 2023
  },
  "contract": {
    "number": "O697YC797",
    "branch": "Центральная"
  },
  "serviceIds": [13, 9, 7, 5, 1, 8],
  "contractTypeId": 62
}

Минимальный набор параметров

Для создания ваучера требуется заполнить следующие обязательные поля в разных блоках запроса:

Информация о клиенте (блок client)

Данные транспортного средства (блок vehicle)

Данные договора (блок contract)

Дополнительные параметры

Расширенную информацию по всем полям, используемым для запроса вы найдёте в описании метода:

• PostVoucher - создать новый ваучер.

Шаг 5. Отправка запроса

Выполните POST-запрос:

curl -X POST "https://dev.api.exodrive.ai/api/v2/Voucher" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_TOKEN" \
-d '{ // тело запроса }'

Возможные ошибки

1. Неверный формат регистрационного номера (использование кириллицы или спецсимволов).
2. Некорректная длина VIN-номера (должно быть ровно 17 символов).
3. Использование неактуальных идентификаторов из справочников.
4. Отсутствие обязательных полей в запросе.
5. Некорректная размерность объёма двигателя.
6. Некорректный год выпуска.
7. Дублирование уникальных значений (номер договора).

Примечания

• Для корпоративных ТС (companyFlag=1) используется упрощенная схема с минимальным набором полей.
• Рекомендуется использовать регистрационный номер в качестве number и lastName.
• Все справочные идентификаторы должны быть предварительно получены через соответствующие методы API. Допускается кеширование или сохранение справочников на стороне клиента, так как на стороне системы изменения уже созданных записей в справочниках не производится.
• Перед отправкой запроса рекомендуется проверить корректность форматов данных.
• При работе с регистрационными номерами всегда используйте только латинские символы.
• VIN-номер должен строго соответствовать формату из 17 символов.