Распознавание СТС¶
parseAuto/multiple/sts¶
Тип HTTP запроса: multipart POST
URL вызова: https://api.id-x.org/idx/api2/parseAuto/multiple/sts
Параметры:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| accessKey | String | Да | Ключ доступа, выданный при регистрации в Системе IDX |
| secretKey | String | Да | Секретный ключ, выданный при регистрации в Системе IDX |
| file | File | Да | Фотография документа |
Проверка распознает следующие форматы: JPG, JPEG, PNG, BMP, TIFF, GIF, PDF, DJVU
Фотография должна соответствовать требованиям к качеству
Функция возвращает:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| resultCode | Int | Да | Результат выполнения функции (0 – успешное завершение функции, -27 – некорректное изображение, иные значения – ошибка выполнения) |
| resultMessage | String | Нет | Сообщение об ошибке |
| operationToken | String | Нет | Уникальный идентификатор операции |
| items | Массив типа Item | Нет | Массив объектов – поле типа документа и объектов полей СТС Подробнее см. поле типа документа и объектов полей СТС |
Пример вызова:
POST /idx/api2/parseAuto/multiple/sts HTTP/1.1
Host: api.id-x.org
Content-Type: multipart/form-data; boundary=----
Accept: application/json
------
Content-Disposition: form-data; name="accessKey"
Выданный accessKey
------
Content-Disposition: form-data; name="secretKey"
Выданный secretKey
------
Content-Disposition: form-data; name="file"; filename="sts.jpg"
Content-Type: image/jpeg
[File data]
------
Пример успешного ответа:
{
"resultCode": 0,
"resultMessage": "",
"operationToken": "faea0efca87d4972b9778977c0ec261c",
"items": [*поле типа документа и объекты полей СТС*]
}
Примеры ответов с разными сторонами СТС
Пример неуспешного ответа:
{
"resultCode": -27,
"resultMessage": "Некорректное изображение."
}
Поле типа документа и объектов полей СТС¶
Тип объекта Item:
| Параметр | Тип | Описание |
|---|---|---|
| docType | String | Тип документа |
| fields | Массив типа Field | Массив объектов – поля считанные с СТС Подробнее см. поля считанные с СТС |
Пример объекта "Поля считанные с СТС" в формате json:
{
"docType": "...",
"fields": [*Поля считанные с СТС*]
}
Поля считанные с СТС¶
Тип объекта Field:
| Параметр | Тип | Описание |
|---|---|---|
| text | String | Значение атрибута |
| confidence | Double | Индекс корректности распознавания |
Это объект, содержащий следующие атрибуты:
| Атрибут | Тип | Описание |
|---|---|---|
| legalEntityRus | Field | Юридическое лицо (rus) |
| legalEntity | Field | Юридическое лицо (eng) |
| carBody | Field | Номер кузова |
| chasis | Field | Шасси |
| color | Field | Цвет |
| ecologicClass | Field | Экологический класс |
| engineHp | Field | Мощность двигателя, л.с. |
| engineKw | Field | Мощность двигателя, кВт |
| mass | Field | Масса без нагрузки |
| maxMass | Field | Разрешенная максимальная масса |
| modelEng | Field | Модель (eng) |
| modelRus | Field | Модель (rus) |
| brandEng | Field | Бренд (eng) |
| brandRus | Field | Бренд (rus) |
| passportNumber | Field | Номер СТС |
| passportSeries | Field | Серия на фронтальной стороне |
| regNumber | Field | Регистрационный номер |
| releaseYear | Field | Год выпуска ТС |
| seriesTop | Field | Серия на обратной стороне сверху |
| numberTop | Field | Номер на обратной стороне сверху |
| type | Field | Тип ТС |
| vin | Field | Идентификационный номер ТС |
| issueDate | Field | Дата выдачи |
| district | Field | Район |
| issueAuthority | Field | Выдано |
| firstNameRus | Field | Имя (rus) |
| firstNameEng | Field | Имя (eng) |
| numberBottom | Field | Номер на обратной стороне снизу |
| seriesBottom | Field | Серия на обратной стороне снизу |
| stateEng | Field | Регион (eng) |
| stateRus | Field | Регион (rus) |
| street | Field | Улица |
| lastNameRus | Field | Фамилия (rus) |
| lastNameEng | Field | Фамилия (eng) |
| midNameRus | Field | Отчество (rus) |
| midNameEng | Field | Отчество (eng) |
| building | Field | Здание |
| city | Field | Город |
| buildingNumber | Field | Номер здания |
| category | Field | Категория |
| documentNumber | Field | Серия и номер документа |
| home | Field | Дом |
Примеры ответов с разными сторонами СТС¶
Пример успешного ответа, при отправке передней стороны СТС в виде json:
{
"docType": "vehicle_registration_certificate_front",
"fields": {
"legalEntityRus": null,
"legalEntity": null,
"carBody": {
"text": "...",
"confidence": 0.9970301389694214
},
"chassis": {
"text": "...",
"confidence": 0.9765521287918091
},
"color": {
"text": "...",
"confidence": 0.5898985862731934
},
"ecologicClass": {
"text": "...",
"confidence": 0.9915384650230408
},
"engineHp": {
"text": "100",
"confidence": 0.9643449187278748
},
"engineKw": {
"text": "100",
"confidence": 0.9643449187278748
},
"mass": {
"text": "1000",
"confidence": 0.9991969466209412
},
"maxMass": {
"text": "1111",
"confidence": 0.9983574151992798
},
"modelEng": {
"text": "OPEL",
"confidence": 0.8378095030784607
},
"modelRus": {
"text": "ОПЕЛЬ",
"confidence": 0.30724069476127625
},
"passportNumber": {
"text": "111111",
"confidence": 0.997256875038147
},
"passportSeries": {
"text": "11AA",
"confidence": 0.997256875038147
},
"regNumber": {
"text": "OOOOOAAA",
"confidence": 0.9779890179634094
},
"releaseYear": {
"text": "2012",
"confidence": 0.999748945236206
},
"type": {
"text": "УНИВЕРСАЛ ЛЕГКОВОЙ",
"confidence": 0.9862152338027954
},
"countryCode": {
"text": "",
"confidence": 0.0
},
"category": {
"text": "B",
"confidence": 0.9957618713378906
},
"documentNumber": {
"text": "1111111111",
"confidence": 0.9978011250495911
}
}
}
}
Пример успешного ответа, при отправке задней стороны СТС в виде json:
{
{
"docType": "vehicle_registration_certificate_back",
"fields": {
"lastNameRus": {
"text": "ИВАНОВ",
"confidence": 0.9992226362228394
},
"firstNameRus": {
"text": "ИВАН",
"confidence": 0.9994235038757324
},
"midNameRus": {
"text": "ИВАНОВИЧ",
"confidence": 0.9913604259490967
},
"lastNameEng": {
"text": "IVANOV",
"confidence": 0.9992226362228394
},
"firstNameEng": {
"text": "IVAN",
"confidence": 0.999990701675415
},
"numberBottom": {
"text": "111111",
"confidence": 0.9970735907554626
},
"seriesBottom": {
"text": "1111",
"confidence": 0.989038348197937
},
"numberTop": {
"text": "111111",
"confidence": 0.9987958669662476
},
"seriesTop": {
"text": "1111",
"confidence": 0.9987388253211975
},
"street": {
"text": "...",
"confidence": 0.9741714596748352
},
"vin": null,
"issueDate": {
"text": "01.01.11",
"confidence": 0.9155398011207581
},
"stateEng": {
"text": "МОСКВА M MOSKVA",
"confidence": 0.9954685568809509
},
"stateRus": {
"text": "МОСКВА M MOSKVA",
"confidence": 0.9954685568809509
},
"issueAuthority": {
"text": "...",
"confidence": 0.2102442979812622
},
"district": {
"text": "...",
"confidence": 0.3880109488964081
},
"building": {
"text": "11",
"confidence": 0.9995378255844116
},
"city": {
"text": "",
"confidence": 0.0
},
"buildingNumber": {
"text": "1",
"confidence": 0.9954691529273987
},
"home": {
"text": "111",
"confidence": 0.9994638562202454
}
}
}
}