Публічний інтерфейс прикладного програмування АРІ

Адреса інтерфейсу АРІ

Інтерфейс прикладного програмування доступний за адресою 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
	}