FMS API

Основна інформація по модулю отримання даних системи.

Для використання АРІ достатньо надіслати POST запити на спеціальну адресу сервера.

Відповіді сервера надходять у JSON-форматі.

Кодування - UTF8.

У заголовку обов'язково вказати тип даних application/json.

Форма відправки пакета - довільний рядок (RAW строка) АБО JSON об'єкт, система автоматично обробить дані в залежності від отриманого типу.

Для тестування функціоналу можна використовувати:

  • Застосунок Postman / Hoppscotch / Insomnia або аналоги

  • Колекція ендпойнтів:

Приклад конфігурації для налагодження через Postman:

  1. Адреса запиту з вказанням методи передачі

  2. Вказанния типа даних

  3. Параметри запиту

У всіх наступних прикладах для налагодження буде використовуватися:

  • Логін - demo@domain.com

  • Пароль - demo

Пароль користувача в систему передається в форматі SHA256.

При шифруванні пароля "demo" по алгоритму SHA256 отримуємо "2a97516c354b68848cdbd8f54a226a0a55b21ed138e207ad6c5cbb9c00aa5aea" значение.

Приклад сформованої строки довільного типу (RAW)

'login=demo@domain.com&pass=2a97516c354b68848cdbd8f54a226a0a55b21ed138e207ad6c5cbb9c00aa5aea&datestart=27.05.2019 00:00:00&datefinish=12.12.2021 23:59:59'

Приклад сформованої строки в форматі JSON

{
	"login":"demo@domain.com",
	"pass":"2a97516c354b68848cdbd8f54a226a0a55b21ed138e207ad6c5cbb9c00aa5aea",
	"datestart":"27.05.2019 00:00:00",
	"datefinish":"12.12.2021 23:59:59"
}

Last updated