Введение в Web API

Web API предоставляет инструменты для интеграции ELMA365 со сторонними системами.

Общая информация

• API работает по протоколу HTTPS путём выполнения HTTP-запросов: GET, POST, PUT и т. д.;
  
• авторизация осуществляется по токену;
  
• все данные доступны только в формате JSON;
  
• базовый URL: https://{company}.elma365.ru/pub/v1;
  
• запросы к данным могут отправляться из любой системы.
  
  

Ознакомиться со всеми методами API можно в статье «Публичный Web API».

При необходимости можно также добавлять свои методы API в пользовательских модулях. Подробнее читайте в официальной справке ELMA365.

Проверка запроса

В ELMA365 можно проверить запрос на работоспособность. Для этого перейдите к списку основных методов API, доступных для компонента:

• для приложения, контракта или отчёта — рядом с его названием нажмите значок . В открывшемся меню выберите пункт API;
  
  

• для процесса — в дизайнере бизнес-процессов перейдите на вкладку Настройки > API.
  
  

В появившемся списке раскройте блок с нужным методом API. При проверке можно задать передаваемые значения или написать тело запроса по шаблону. Вы получите:

• URL запроса, сформированный с учётом параметров;
  
• код и тело ответа от сервера.
  
  

Обратите внимание, пробные запросы выполняются в системе. Например, при проверке методов API для создания или редактирования элементов приложения произойдёт изменение данных.

Подробнее читайте в официальной справке ELMA365.