Все методы требуют basic-авторизацию. Логин/пароль отправляются по запросу.
https://d.knopka.com/restApi/publicApi/accCompany/v1/createPackage
Это POST.
Параметр:
У этого метода есть один GET параметр. Это ИНН организации, для которой осуществляется загрузка. Имя параметра Inn.
Содержимое — это multipart request, который содержит один или несколько файлов для загрузки в пакете. Таймаут стоит 600 секунд, так что большинство пакетов должно пролезать.
Возвращает: ID пакета
Пример запроса: https://d.knopka.com/restApi/publicApi/accCompany/v1/createPackage?Inn=7704582421
https://d.knopka.com/restApi/publicApi/accCompany/v1/getPackageState
Это GET запрос.
Параметры:
У него один параметр — это ID пакета, который вы получили при отправке через API. Имя параметра packageId.
Этот метод позволяет узнать статус обработки пакета. В некоторых случаях статус может меняться асинхронно. Это может занимать до 20 минут.
Возможные варианты статуса с расшифровкой:
Pending — когда еще не распаковали пакет (там могут быть какие-нибудь zip архивы или еще что-то что нужно пилить) Error — это в случае множественной ошибки распаковки. Почти всегда это когда битые пдфки присылают. InProgress — мы обрабатываем, мячик на нашей стороне Processed — всё готово, все сканы в одном из финальных сотояний NeedAttention — требуется ваше внимание. Мы все что могли по пакету сделали, но он еще не готов, мячик на вашей стороне. Тут в основном случай когда мы задали уточняющий вопрос по скану.
Возвращает: json со статусом обработки. Типа такого:
{