Інтерфейс прикладного програмування доступний за адресою https://rest.kremen.org.ua/api
Для отримання даних необхідно виконати запит до функції АРІ інтерфейсу, вказавши ідентифікатор сервісу.
https://rest.kremen.org.ua/api/[ідентифікатор]
Наприклад:
https://rest.kremen.org.ua/api/info
Параметри запросу передаються в полі message-body у форматі JSON, або методом POST відповідно до HTTP протоколу.
Наприклад:
{
"param": true,
"param1": "text",
"param2": 999
}
Параметри передаються відповідно до специфікації кожного окремого сервісу АРІ.
Відповідь надається у форматі JSON або XML відповідно до переданого клієнтом поля Accept.
{
"success": true, //обов'язковий параметр
"data": {.....},
}
або у форматі XML
<?xml version="1.0" encoding="UTF-8" ?>
<response>
<success>true</success>
<data>....</data>
</response>
{
"success": false, //обов'язковий параметр
"message": "Requested data not found"
}
{
"success": false, //обов'язковий параметр
"error": true, //обов'язковий параметр
"message": "Not Found",
"code": 404
}