ЭПТС

<ОПИСАНИЕ>

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

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

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

Структура запроса:

url: https://api.beorg.ru/api/bescan/add_document
method: POST
headers:
    Content-Type: application/json

body:
{
    "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	настройки обработки

Структура prosess_info:

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

Структура process_info.options:

Ключ	Описание
stages	этапы обработки документа (Доступны: verification, biometry_match, biometry_liveness)
relation	связь с иным документом в одном запросе (Доступны: biometry_match)

Для получения 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",
            }
        ],
    },
)
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"
                ]
      }
    ],
  },
)
r.json()

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

Структура запроса:

url: https://api.beorg.ru/api/document/result/s-12345?token=
methods: GET, POST

Python

import requests
import base64
r = requests.get("https://api.beorg.ru/api/document/result/s-12345?token=")
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.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"
        }
      }
    }
  ]
}

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

Ключ	Тип	Описание
document_id	string	номер документа в формате s-<номер документа>
documents	list	список данных по каждому документу
documents[].key	string	ключ заданный при отправке документа для отслеживания
documents[].type	string	тип документа
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	Рабочий объем цилиндров (см3)
EnginePower	string	Максимальная мощность (кВт) (мин-1)
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.