QuickBPM API — это инструментарий для интеграции QuickBPM со сторонними системами.
Общая информация
- Всё API работает по протоколу HTTPS, путем выполнения POST-запросов.
- Авторизация осуществляется по токену.
- Все данные доступны только в формате JSON.
- Базовый URL — https://{company}.quickbpm.ru/pub/v1.
- Возможны запросы к данным из любой системы.
Ознакомится с существующими функциями можно в статье Web API.
Параметры запроса
Параметры запроса передаются:
- В URL — идентификаторы.
- В теле запроса — методы API.
В теле запроса укажите данные в формате JSON.
Более подробно ознакомится с функциями в системе QuickBPM можно в статье Web API.
Авторизация по токену
- Токен передается в заголовке http-запроса.
«X-Token»: «4bece94a-d372-404f-a4be-fb159019d9e0»,
- Для пользователя индивидуально создается токен и все запросы отправляются от имени пользователя.
Управление правами на API осуществляется с помощью токена.
Проверка запроса
В системе QuickBPM можно проверить запрос на работоспособность.
Для проверки запроса, нажмите на иконку рядом с названием Приложения и выберите пункт меню API.
Перейдите на вкладку нужного метода и откройте вкладку Проверить. Затем введите тело запроса и нажмите на кнопку Отправить.
Результат запроса отобразиться в поле Результат.
Более подробно про существующие функции читайте в статье Web API.