Наш сервис позволяет конвертировать документы в 3х вариантах, через веб сервис онлайн конвертации, через десктопное приложение Hedo connector и через API сервис Hedo API, ниже приведены параметры API вызова.

Сервис позволяет конвертировать xls, xlsx документы с типовой формой УПД и Счет-фактуры. Сама по себе конвертация выполняется точно так же как в онлайн сервисе, если вы хотите проверить как конвертируется тот или иной файл вы может попробовать в онлайн конвертации. Возможна кастомизация конвертации, для этого, пожалуйста, свяжитесь с нами.

Адрес сервиса

https://api.help-edo.ru/api/

Авторизация 

При выполнении любого метода, передайте в заголовке параметр ApiKey со значением которое будет предоставлено вам после подключения услуги Hedo API.

Так же можете связаться с нами и запросить тестовый ключ для проверки и обкатки запросов.  

Метод: /api/converter/v2/convert

На входе метод принимает XLS, XLSX файл (бинарные данные) через параметр file, на выходе возвращает json структуру с данными, в которой бинарные данные конвертированного XML файла закодированы в Base64.

Headers

    • ApiKey = GUID выданного вам API-ключа
    • TrackingId = GUID для отслеживания запроса, возвращается в ответе

Body

    • file = бинарный xls, xlsx файл
    • *params = *values (любые произвольные параметры которые можно обработать конвертером, используется для кастомной конвертации).

Параметр id_conv позволяется указать сервису что надо конвертировать файл с использованием кастомного конвертера. Значение параметра предоставляется после реализации.

Response

В ответе сервис возвращает json структуру:

{
«status»: «SUCCESS»,
    «trackingId»: «1ea9729b-36bd-4324-aff3-5ce9d060eb76»,
    «fileName»: «file_name.xml»,
    «fileContent»: «PD94bWw…..»
}
  • status — статус конвертации
  • trackingId — GUID запроса, если он не был передан на входе, то будет сгенерирован новый
  • fileName — имя файла с расширением xml
  • fileContent — бинарные данные в формате XML закодированные в Base64

Пример

Документация Hedo API

Метод: /api/converter/convert

Аналог запроса /api/converter/v2/convert, на входе принимает бинарные данные XLS, XLSX, на выходе отдает сконвертированные бинарные данные в формате XML.

Headers

    • ApiKey = GUID выданного вам API-ключа

Body

    • file = бинарный xls, xlsx файл
    • *params = *values (любые произвольные параметры которые можно обработать конвертером, используется для кастомной конвертации) 

Параметр id_conv позволяется указать сервису что надо конвертировать файл с использованием кастомного конвертера. Значение параметра предоставляется после реализации.

Response

В ответе сервис возвращает сконвертированные бинарные данные в формате XML.

Метод: /api/converter/stat/subscriptions

Метод который позволяет прочитать данные по действующим подпискам.  
Если нет действующих подписок, будет возвращена ошибка. 

Headers

    • ApiKey = GUID выданного ключа

Body

    • Параметры не передаются

Response

[{
        «status»: «Available»,
        «startDate»: «25.02.2024»,
        «endDate»: «24.08.2024»,
        «totalLimit»: «500»,
        «successful»: «7»,
        «available»: «493»
}]

Возможные ошибки

  1. «Отсутствует ApiKey в заголовке. No ApiKey in the header.»
    В заголовке не был указан API-ключ.
  2. «Неверный ApiKey. Incorrect ApiKey.»
    В заголовке указан некорректный API-ключ.
  3. «Файл не был передан или он пуст. The file has not been transferred or it is empty.»
    В Body не был передан параметр file с бинарными данными.
  4. «Недопустимое расширение файла. Разрешены только файлы с расширением .xls, .xlsx. This file extension is not allowed.»
    Типовая конвертация возможна только Excel файлов с расширением xls, xlsx.