Опис API е-кабінету¶

API або прикладний програмний інтерфейс (англ. Application Programming Interface,) - це набір визначень взаємодії різнотипного програмного забезпечення. «Електронний кабінет» за допомогою АРІ забезпечує взаємодію з різноманітним програмним забезпеченням, що реалізує функції подання звітності.

Взаємодія через програмний інтерфейс REST АРІ¶

REST (скор. англ. Representational State Transfer, «передача репрезентативного стану») — підхід до архітектури мережевих протоколів, які забезпечують доступ до інформаційних ресурсів.

Дані передаються у вигляді стандартного формату JSON (до якого вкладено підписаний та зашифрований XML документ).

Робота АРІ Кабінету організована наступним чином:

Розташування у мережі Internet:

Вузол: https://cabinet.fiu.gov.ua

Основной шлях: /public/api/exchange

Повний шлях: https://cabinet.fiu.gov.ua/public/api/exchange/

Надсилання звіту за допомогою REST АРІ¶

Метод, що використовується: POST.

Додатковий шлях (додається до основного або повного шляху): /report

Параметри¶

Приймає - application/json

Сформований XML-документ повинен бути підписаний в одному файлі, алгоритм підпису ДСТУ 4145, формат підпису CAdES-X Long - довогостроковий з повними даними для перевірки, зашифрований та переданий в параметрі contentBase64

Відкритий сертифікат шифрування е-Кабінету

Ім'я файлу-повідомлення в форматі Zx0123456789YYYYMMDD.nnn де:

• x- тип файлу-повідомлення
• 0123456789 - код ЄДРПОУ/РНОКПП

[
    {
        "fname": "Ім'я файлу-повідомлення",
        "contentBase64": "файл-повідомлення підписане особистим КЕП відправника зашифроване на відкритий сертифікат шифрування е-Кабінету та закодоване у Base64",
        "crtCryptBase64": "Відкритий сертифікат шифрування відправника закодований у Base64"
    }
]

Відповіді¶

Повертає - application/json за тим же шляхом

Отримання квитанцій за допомогою REST АРІ¶

Метод, що використовується: POST

Додатковий шлях (додається до основного): /kvt_by_id

Параметри¶

Приймає - application/json

Ідентифікатор повідомлення повинен бути підписаний в одному файлі, алгоритм підпису ДСТУ 4145, формат підпису CAdES-X Long - довогостроковий з повними даними для перевірки, зашифрований та переданий в параметрі encryptedId

Відкритий сертифікат шифрування е-Кабінету

{
    "encryptedId": "Ідентифікатор повідомлення (ID), підписаний особистим КЕП відправника, зашифрований на відкритий сертифікат шифрування е-Кабінету та закодований у Base64",
    "crtCryptBase64": "Відкритий сертифікат шифрування відправника закодований у Base64"
}

Відповіді¶

Повертає - application/json за тим же шляхом

Визначення¶

InReportDao¶

ReturnKvt¶

ReturnReport¶

RequestKvt¶