Описание интеграции и API

Начало работы

Перед началом работы с API необходимо:

1. Зарегистрироваться в системе
2. Получить ключи доступа (token и machine_uid) и идентификатор сценария обработки документа (project_id)

Для получения ключей доступа:

1. Перейдите в раздел Проекты и нажмите на кнопку :

   

2. В открывшемся окне вам доступны token, machine_uid и project_id. Также доступны примеры по загрузке документов на обработку и получения результатов обработки:

   

Описание работы

Для организации взаимодействия с системой и настройки обработки документов нужно реализовать два метода API.

1. Запрос на загрузку документа в систему. По пути /api/bescan/add_document отправляется файл, файл в формате строки base64 для обработки и параметры token, machine_uid, project_id. При успешной отправке в теле ответа будет номер созданного документа в ключе document_id, его нужно использовать для получения результата.

   • 200 – Успешная загрузка, возвращается ключ document_id номера документа;

2. Запрос на получение результата обработки. В случае успешной загрузки, по ключу document_id с помощью эндпоинта /api/bescan/result можно запросить результат обработки. В качестве ответа возвращается:

   • 200 - Успешный результат обработки, возвращается результат обработки;

При возвращении результата обработки с кодом «200», возвращаются в блоке «data» наборы полей в форме {ключ: значение} и в блоке metadata-confidences метаданные об оценках уровня уверенности для каждого поля распознанного поля; При возвращении ответа с кодом НЕ 200, см. раздел Коды ошибок;

Схема работы с API

С обобщенным техническим описанием API и кодов ошибок можно ознакомиться по ссылке.

С наглядным примером использования на выбранных проектах можно ознакомиться в разделах Проекты, Тариф Биорг.Паспорт Авто, Тариф Биорг.Универсальный