# Введение

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

# Примеры

# Java

В примерах ниже для удобства будут использоваться

Jackson (для сериализации в JSON),
клиентская библиотека wfe-restapi (содержащая все необходимые dto),
а также Jetty (для выполнения HTTP запросов), пример зависимостей:

        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
        </dependency>
        <dependency>
            <groupId>ru.runa.wfe</groupId>
            <artifactId>wfe-restapi</artifactId>
            <classifier>client</classifier>
        </dependency>
        <dependency>
            <groupId>org.eclipse.jetty.websocket</groupId>
            <artifactId>javax-websocket-client-impl</artifactId>
        </dependency>

RestApiDeveloperGuide

Содержание