RestApiDeveloperGuide: различия между версиями
(Новая страница: «{{PageHeading|Руководство по работе с Resr API}}») |
м |
||
| Строка 1: | Строка 1: | ||
{{PageHeading|Руководство по работе с Resr API}} | {{PageHeading|Руководство по работе с Resr API}} | ||
{{Licensing}} | |||
= {{Title|Introduction|Введение}} = | |||
<b>RunaWFE REST API</b> - restful API RunaWFE–сервера, предоставляющий доступ к большинству доступных операций внутри системы | |||
(работа с определениями БП, БП, задачами, пользователями, отношениями, логами и т.д.). | |||
OpenApi спецификация находится <a href="https://github.com/processtech/runawfe-free-server/blob/master/wfe-restapi-client/src/main/resources/api-docs.json">тут</a>, | |||
исходный код - <a href="https://github.com/processtech/runawfe-free-server/tree/master/wfe-restapi/src/main/java/ru/runa/wfe/rest/impl">тут</a>. | |||
Аутентификация происходит стандартным способом - посредством передачи JWT в заголовке Authorization (e.g. '-H "Authorization: Bearer ${jwt}")'). | |||
Авторизация - путем передачи данных (зачастую логина и пароля) в соответствующие методы и получения JWT (подробнее - <a href="#auth">в отдельном блоке</a>). | |||
Базовый урл - <b>/restapi</b> (например, для localhost - localhost/restapi/) | |||
= {{Title|apis|Краткая информация об основных API}} = | |||
<h2 id="apis">Краткая информация об основных API</h2> | |||
<div> | |||
== {{Title|apis-auth|Auth API}} == | |||
Базовый урл - <b>/auth</b> (например, для localhost - localhost/restapi/auth). | |||
Отвечает за авторизацию пользователей и содержит 3 метода: | |||
* <b>/basic</b> - авторизация по логину и паролю | |||
* <b>/kerberos</b> - авторизация по kerberos токену | |||
* <b>/trusted</b> - авторизация по trusted принципу | |||
== {{Title|apis-def|Definition API}} == | |||
Базовый урл - <b>/definition</b> (например, для localhost - localhost/restapi/definition). | |||
Отвечает за работу с определениями БП, основные методы: | |||
* <b>/</b> - загрузка нового определения БП | |||
* <b>/list</b> - получение определений БП по заданному фильтру | |||
* <b>/{id}</b> - получение определения БП по id | |||
Версия 14:11, 2 октября 2024
Руководство по работе с Resr API
Версия 4.6.0
© 2015-2023, ООО "Процессные технологии"
# Введение
RunaWFE REST API - restful API RunaWFE–сервера, предоставляющий доступ к большинству доступных операций внутри системы (работа с определениями БП, БП, задачами, пользователями, отношениями, логами и т.д.).
OpenApi спецификация находится <a href="https://github.com/processtech/runawfe-free-server/blob/master/wfe-restapi-client/src/main/resources/api-docs.json">тут</a>,
исходный код - <a href="https://github.com/processtech/runawfe-free-server/tree/master/wfe-restapi/src/main/java/ru/runa/wfe/rest/impl">тут</a>.
Аутентификация происходит стандартным способом - посредством передачи JWT в заголовке Authorization (e.g. '-H "Authorization: Bearer ${jwt}")').
Авторизация - путем передачи данных (зачастую логина и пароля) в соответствующие методы и получения JWT (подробнее - <a href="#auth">в отдельном блоке</a>).
Базовый урл - /restapi (например, для localhost - localhost/restapi/)
# Краткая информация об основных API
Краткая информация об основных API
# Auth API
Базовый урл - /auth (например, для localhost - localhost/restapi/auth).
Отвечает за авторизацию пользователей и содержит 3 метода:
- /basic - авторизация по логину и паролю
- /kerberos - авторизация по kerberos токену
- /trusted - авторизация по trusted принципу
# Definition API
Базовый урл - /definition (например, для localhost - localhost/restapi/definition).
Отвечает за работу с определениями БП, основные методы:
- / - загрузка нового определения БП
- /list - получение определений БП по заданному фильтру
- /{id} - получение определения БП по id