Введение в Web API

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

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

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

Размер веб-запроса не может превышать 50 мегабайт.

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

Параметры запроса

В качестве параметров запроса используются:

  • В URL — идентификаторы.
  • В теле запроса — методы API.

В теле запроса данные передаются в формате JSON.

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

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

В ELMA365 можно проверить запрос на работоспособность.

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

Выберите нужный метод. В нижней части страницы перейдите на вкладку Проверить. Затем в поле Запрос введите тело запроса и нажмите кнопку Отправить.

Результат запроса отобразится в поле Результат:

Более подробно про существующие методы читайте в статье «Публичный Web API».