Документ об образовании и (или) квалификации

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

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

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

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

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

{
  "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": "DIPL1",
                "type": "DIPL"
            }
        ]
    }
)
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-39164",
  "documents": [
    {
      "key": "DIPL1",
      "type": "DIPL",
      "data": {
        "UniversityName": "",
        "EducationDocumentType": "",
        "EducationType": "",
        "Series": "",
        "Number": "",
        "IssueDate": "",
        "StartDate": "",
        "EndDate": "",
        "TrainingHoursNumber": "0",
        "Gender": "F",
        "LastName": "",
        "FirstName": "",
        "MiddleName": "",
        "Specialty": "",
        "Qualification": ""
      },
      "metadata": {
        "confidences": null,
        "verifications": {}
      },
      "broken": false,
      "broken_reasons": [],
      "broken_reasons_ru": []
    }
  ]
}

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

Ключ	Тип	Описание
document_id	string	Номер документа в формате s-<номер документа>
documents	list	Список данных по каждому документу
documents[].key	string	Ключ, заданный при отправке документа для отслеживания
documents[].type	string	Тип документа
documents[].data	dictionary	Обработанные данные по каждому полю, содержит ключи полей и их определённые значения
UniversityName	string	Название университета
EducationDocumentType	string	Тип документа об образовании
EducationType	string	Тип образования
Series	string	Серия диплома
Number	string	Номер диплома
IssueDate	string	Дата выдачи диплома
StartDate	string	Дата обучения (с)
EndDate	string	Дата обучения (по)
TrainingHoursNumber	string	Продолжительность обучения (количество часов)
Gender	string	Пол
LastName	string	Фамилия
FirstName	string	Имя
MiddleName	string	Отчество
Specialty	string	Специальность
Qualification	string	Квалификация
metadata	dictionary	Содержит ключи метаданных
confidences	dictionary ({key: float})	Метаданные с точностью обработки по каждому полю — содержит ключи полей и значения уровня уверенности. Значения от 0.0000 до 0.9999, где чем значение больше, тем уверенность в результате выше. Максимальная уверенность — 0.9999
broken	boolean	Является ли документ бракованным
broken_reasons	list	Список причин брака (на английском языке)
broken_reasons_ru	list	Список причин брака (на русском языке)