Описание API для сервиса распознавания документов

В этой работе мы разработали описание прикладного программного интерфейса (API) для сервиса по распознаванию документов. Особенностью работы было то, что сервис практически не имел графического интерфейса (все операции по распознаванию выполнялись на серверном оборудовании) и взаимодействие с ним возможно было только через API. Обмен данными осуществлялся при помощи https запросов в формате JSON. В проекте использовался классический REST API, архитектура приложения клиент-серверная.   

Была возможность тестирования API в сервисе Swagger и также нам были доступны консультации разработчика приложения. С работой мы справились и на свет появился документ с объемом чуть больше 100 листов формата А4, содержащий описание всех основных методов работы с API. Ниже приводим некоторые выдержки из документа: