Есть раздел в навигаторе, есть вот эти пункты (API Module, API version, API action, API request parameter, API Action request param, API module request param), ведут на определенные справочники.
Сначала админ создает у себя API Module
Path - поковыряться в сервиснау
API Module это сущность, требуемая для объединения прочих сущностей, API version, API action.
Для создания нужно перейти в Scripted REST API → API Module и нажать New
API Module form fields
| Field | Description |
|---|---|
| Name | Человекочитаемое имя |
| Path | Путь для запроса, например /rest |
| Active | Булевый чекбокс |
API version form fields
| Field | Description |
|---|---|
| Module | Референс на API Module ранее созданный. Будут доступны только активные модули (active = yes), |
| Active | Булевый чекбокс |
| Path | Путь для запроса |
API action form fields
| Field | Description |
|---|---|
| Name | Человекочитаемое имя |
| Path | Путь |
| Active | Булевый чекбокс |
| Is Authentication Required | Указываем, если запрос требует аутентификации (токен передается в хедере запроса) |
| Module | Референс на API Module |
| Version | Референс на API Version |
| HTTP Method | Выбираем метод (GET, POST, какой-то ещё) |
| Script | вводим скрипт, можно использовать классы SimpleRequest и SimpleResponse |
API Request parameter form fields
| Field | Description |
|---|---|
| Name | Человекочитаемое имя |
| Is required | Указать, если это требуемый параметр |
API action request parameters form fields
| Field | Description |
|---|---|
| Action | Референс на API action |
| Request parameter | Референс на API request parameter |
API Module request parameters form fields
| Field | Description |
|---|---|
| Module | Референс на API module |
| Request parameter | Референс на API request parameter |
