API

API ISpro (Application Programming Interface) – програмний інтерфейс Комплексу ISpro, що представляє собою набір інструментів (структур, процедур, класів, функцій), властивостей і методів для взаємодії з об’єктами Комплексу.

REST API ISpro (Representational state transfer) – інструмент, що забезпечує взаємодію та обмін інформацією з різних джерел (виконує роль посередника): бази даних Комплексу, веб-системи ISpro, мобільних додатків та ін.

Обмін даними між різними системами (веб-системою, десктопною версією Комплексу, мобільними додатками) у REST API здійснюється за протоколом HTTP. У свою чергу, REST API ISpro надає список URL-адрес, за допомогою яких сервер аплікацій може приймати запити на отримання, збереження, оновлення і видалення даних.

Для опису REST API використано специфікацію OpenAPI (формальна назва – Swagger).

У OpenAPI замість XML-формату використовується набір JSON-об'єктів з певною схемою, яка визначає їх найменування, порядок і вміст. Ці файли JSON, часто описуються в YAML (JSON-подібна мові розмітки, з розширеними можливостями) і містять представлення кожної частини API.

Перелік актуальних доступних методів та контролерів наведено у сервері застосунків.

В правому верхньому куті по пункту ISpro Core API відкривається вікно переліку методів та контролерів. По кнопці Пошук можна знайти необхідний.