ЭПТС

Примеры изображений документов:

Важно: документы для обработки должны быть закодированы в формат base64.

Отправка документа

Endpoint: POST https://api.beorg.ru/api/bescan/add_document

Заголовки:

Content-Type: application/json

Тело запроса:

{
  "project_id": "U_RATE_2",
  "images": ["<строка base64>"],
  "process_info": [/* настройки обработки */],
  "token": "<token>",
  "machine_uid": "<machine_uid>"
}

Пример ответа об успешной загрузке:

{
  "document_id": "s-12345"
}

Структура передаваемых данных

Ключ	Описание
`project_id`	Название проекта
`token`	Токен доступа
`machine_uid`	Идентификатор устройства
`images`	Список строк в формате base64 (файлов)
`process_info`	Настройки обработки

Структура `process_info`

Ключ	Описание
`key`	Свободный ключ для разделения документов при загрузке и получении результатов. Если не указан, вместо него используется ключ `type`
`type`	Тип документа
`options`	Опции обработки документа

Для получения token, machine_uid и project_id обратитесь в подраздел «Начало работы».

Пример запроса (Python)

Базовый вариант (без указания этапов обработки):

import requests
import base64

with open("<путь до файла ЭПТС>", "rb") as image_file:
    b64 = base64.b64encode(image_file.read()).decode()

r = requests.post(
    "https://api.beorg.ru/api/bescan/add_document",
    headers={"Content-Type": "application/json"},
    json={
        "project_id": project_id,
        "token": token,
        "machine_uid": machine_uid,
        "images": [b64],
        "process_info": [
            {
                "key": "EPTS1",
                "type": "EPTS"
            }
        ]
    }
)
print(r.json())

Вариант с улучшением качества обработки (verification):

import requests
import base64

with open("<путь до файла ЭПТС>", "rb") as image_file:
    b64 = base64.b64encode(image_file.read()).decode()

r = requests.post(
    "https://api.beorg.ru/api/bescan/add_document",
    headers={"Content-Type": "application/json"},
    json={
        "project_id": project_id,
        "token": token,
        "machine_uid": machine_uid,
        "images": [b64],
        "process_info": [
            {
              "key": "EPTS1",
              "type": "EPTS",
              "options": {
                  "stages": ["verification"]
              }
            }
        ]
    }
)
print(r.json())

Получение результатов

Endpoint: GET/POST https://api.beorg.ru/api/document/result/s-12345?token=<token>

Пример запроса для получения результатов (Python):

import requests

r = requests.get("https://api.beorg.ru/api/document/result/s-12345?token=<token>")
print(r.json())

Пример ответа по обработанному документу

{
  "document_id": "s-12345",
  "documents": [
    {
      "key": "EPTS1",
      "type": "EPTS",
      "data": {
        "EPTSNumber": "EPTSNumber",
        "EPTSStatus": "EPTSStatus",
        "CreatedDate": "CreatedDate",
        "Vin": "Vin",
        "Brand": "TOYOTA",
        "Model": "CAMRY",
        "VehicleCategory": "КАТЕГОРИЯ B",
        "VehicleType": "M1",
        "EngineNumber": "EngineNumber",
        "VehicleChassis": "ОТСУТСТВУЕТ",
        "VehicleBody": "VehicleBody",
        "Color": "ЧЕРНЫЙ",
        "ReleaseYear": "2024",
        "HybridVehicleDesign": "",
        "EngineGas": "",
        "EngineCylinderVolume": "1987",
        "EnginePower": "127(6600)",
        "EngineElectricFirst": "",
        "WorkVoltageFirst": "",
        "MaxPowerFirst": "",
        "EngineElectricSecond": "",
        "WorkVoltageSecond": "",
        "MaxPowerSecond": "",
        "EcologicalClass": "ПЯТЫЙ",
        "MaxMass": "2030",
        "PrintedDate": null,
        "OrgRegistered": "",
        "Modification": "ОТСУТСТВУЕТ",
        "ChassisColor": "ОТСУТСТВУЕТ",
        "Mass": "",
        "DriveWheels": "",
        "NumSeats": "",
        "Transmission": "ГИДРОМЕХАНИЧЕСКАЯ, С АВТОМАТИЧЕСКИМ УПРАВЛЕНИЕМ",
        "FuelType": "БЕНЗИН",
        "VehicleTypeApproval": "",
        "EmergencyServicesNumber": "EmergencyServicesNumber",
        "Manufacturer": "",
        "ManufacturerAddress": "",
        "RecyclingPayCountry": "",
        "RegisteredCountry": "РОССИЙСКАЯ ФЕДЕРАЦИЯ",
        "RegisteredCountryAnyInfo": "RegisteredCountryAnyInfo",
        "CustomsOrderSeriesNumber": "CustomsOrderSeriesNumber",
        "CustomsRestrictions": "ОТСУТСТВУЮТ",
        "Owner": "Owner",
        "AnyRestrictions": "СВЕДЕНИЯ ОБ ОГРАНИЧЕНИЯХ ОТСУТСТВУЮТ"
      },
      "metadata": {
        "confidences": {
          "AnyRestrictions": 1.0,
          "Brand": 1.0,
          "ChassisColor": 1.0,
          "Color": 1.0,
          "CreatedDate": 1.0,
          "CustomsOrderSeriesNumber": 1.0,
          "CustomsRestrictions": 1.0,
          "DriveWheels": 1.0,
          "EcologicalClass": 1.0,
          "EmergencyServicesNumber": 1.0,
          "EngineCylinderVolume": 1.0,
          "EngineElectricFirst": 1.0,
          "EngineElectricSecond": 1.0,
          "EngineGas": 1.0,
          "EngineNumber": 1.0,
          "EnginePower": 1.0,
          "EPTSNumber": 1.0,
          "EPTSStatus": 1.0,
          "FuelType": 1.0,
          "HybridVehicleDesign": 1.0,
          "Manufacturer": 1.0,
          "ManufacturerAddress": 1.0,
          "Mass": 1.0,
          "MaxMass": 1.0,
          "MaxPowerFirst": 1.0,
          "MaxPowerSecond": 1.0,
          "Model": 1.0,
          "Modification": 1.0,
          "NumSeats": 1.0,
          "OrgRegistered": 1.0,
          "Owner": 1.0,
          "PrintedDate": 1.0,
          "RecyclingPayCountry": 1.0,
          "RegisteredCountry": 1.0,
          "RegisteredCountryAnyInfo": 1.0,
          "ReleaseYear": 1.0,
          "Transmission": 1,
          "Transmission": 1.0,
          "VehicleBody": 1.0,
          "VehicleCategory": 1.0,
          "VehicleChassis": 1.0,
          "VehicleType": 1.0,
          "VehicleTypeApproval": 1.0,
          "Vin": 1.0,
          "WorkVoltageFirst": 1.0,
          "WorkVoltageSecond": 1.0
        }
      },
      "broken": false,
      "broken_reasons": [],
      "broken_reasons_ru": []
    }
  ]
}

Описание ключей в ответе

Ключ	Тип	Описание
`document_id`	string	Номер документа в формате `s-<номер документа>`
`documents`	list	Список данных по каждому документу
`documents[].key`	string	Ключ, заданный при отправке документа для отслеживания
`documents[].type`	string	Тип документа (`EPTS`)
`documents[].data`	dictionary	Обработанные данные по каждому полю — содержит ключи полей и их определённые значения
`EPTSNumber`	string	Номер ЭПТС
`EPTSStatus`	string	Статус ЭПТС
`CreatedDate`	string	Дата оформления электронного паспорта
`Vin`	string	VIN‑номер
`Brand`	string	Марка автомобиля
`Model`	string	Модель автомобиля
`VehicleCategory`	string	Категория транспортного средства в соответствии с Конвенцией о дорожном движении
`VehicleType`	string	Категория в соответствии с ТР ТС 018/2011
`EngineNumber`	string	Номер двигателя (двигателей)
`VehicleChassis`	string	Номер шасси (рамы)
`VehicleBody`	string	Номер кузова (кабины, прицепа)
`Color`	string	Цвет кузова (кабины, прицепа)
`ReleaseYear`	string	Год изготовления
`HybridVehicleDesign`	string	Описание конструкции гибридного транспортного средства
`EngineGas`	string	Двигатель внутреннего сгорания (марка, тип)
`EngineCylinderVolume`	string	Рабочий объём цилиндров (см³)
`EnginePower`	string	Максимальная мощность (кВт) (мин⁻¹)
`EngineElectricFirst`	string	Электромашина (марка, тип) / электродвигатель — первый привод
`WorkVoltageFirst`	string	Рабочее напряжение (В) — первый привод
`MaxPowerFirst`	string	Максимальная 30‑минутная мощность (кВт) — первый привод
`EngineElectricSecond`	string	Электромашина (марка, тип) / электродвигатель — второй привод
`WorkVoltageSecond`	string	Рабочее напряжение (В) — второй привод
`MaxPowerSecond`	string	Максимальная 30‑минутная мощность (кВт) — второй привод
`EcologicalClass`	string	Экологический класс
`MaxMass`	string	Технически допустимая максимальная масса транспортного средства (кг)
`PrintedDate`	string	Дата и время формирования
`OrgRegistered`	string	Наименование организации, оформившей ЭПТС
`Modification`	string	Модификация
`ChassisColor`	string	Оттенок цвета в соответствии со спецификацией изготовителя
`Mass`	string	Масса транспортного средства в снаряжённом состоянии (кг)
`DriveWheels`	string	Колёсная формула / ведущие колёса
`NumSeats`	string	Количество мест для сидения
`Transmission`	string	Трансмиссия (тип)
`FuelType`	string	Вид топлива
`VehicleTypeApproval`	string	Документ, подтверждающий соответствие требованиям безопасности
`EmergencyServicesNumber`	string	Идентификационный номер устройства вызова экстренных служб
`Manufacturer`	string	Изготовитель
`ManufacturerAddress`	string	Адрес изготовителя
`RecyclingPayCountry`	string	Страна уплаты утилизационного сбора
`RegisteredCountry`	string	Территория, где применяется статус «Действующий»
`RegisteredCountryAnyInfo`	string	Иная информация организации, оформившей ЭПТС
`CustomsOrderSeriesNumber`	string	Номер таможенного документа
`CustomsRestrictions`	string	Таможенные ограничения
`Owner`	string	Собственник
`AnyRestrictions`	string	Ограничения (обременения), кроме таможенных
`metadata`	dictionary	Содержит ключи метаданных
`confidences`	dictionary (`{key: float}`)	Метаданные с точностью обработки по каждому полю — содержит ключи полей и значения уровня уверенности. Значения от `0.0000` до `0.9999`, где чем значение больше, тем уверенность в результате выше. Максимальная уверенность — `0.9999`
`broken`	boolean	Является ли документ бракованным
`broken_reasons`	list	Список причин брака (на английском языке)
`broken_reasons_ru`	list	Список причин брака (на русском языке)