Операция API

api

Выполняет операцию запроса к API Oktell Studio с указанием домена и логина. Запрос производится напрямую к роли обработчика исключая TCP-соединение. Параметры запроса похожи на параметры компонента Web-запрос с некоторыми отличиями. Не требуется указывать параметры прокси, канал интеграции, кодировку и использовать базовую аутентификация, куки. Достаточно указать параметры домен и логин. Вместо параметра URL указывается параметр Путь, в котором принимается не полный URL, а только путь API. Параметры запроса передаются в отдельном поле Запрос. Заголовки принимаются и возвращаются в формате JSON-объекта.

Дополнительным условием осуществления API запроса является параметр в настройках пользователя, от имени которого выполняется запрос. Для этого требуется активировать параметр Разрешать выполнение операций в API сценария в Права доступа пользователя.

Рис. 1. Разрешать выполнение операций в API сценария

Название	Описание
Домен	Домен запроса. Если сценарий исполняется в мастер-домене, то запрос может выполняться в любом домене. Если сценарий исполняется в рабочем домене, то здесь можно указать либо сам домен, либо поддомен сценария.
Логин	Пользователь в домене для запроса. Можно указать любого пользователя, и он должен существовать в домене запроса.
Метод	Возможные варианты: GET, POST, PATCH, PUT, DELETE
Путь	Путь запроса. Часть URL, следующая после схемы и имени хоста, исключая запрос. Например: https://cloud.oktell.studio/api/admin/v1/project/read?filter={"id":"345"} - полный URL, в котором /api/admin/v1/project/read - путь, а filter={"id":"345"} - запрос
Запрос	Запрос часть URL, следующая за знаком вопроса. Сам знак вопроса не пишется. Например: http://cloud.oktell.studio/api/admin/v1/project/read?filter={"id":"345"} - полный URL, в котором /api/admin/v1/project/read - путь, а filter={"id":"345"} - запрос
Заголовки	Подставляемые в запрос дополнительные HTTP-заголовки. Принимается JSON-объект либо заголовки построчно
Время, мс	Таймаут ожидания ответа на отправленный HTTP-запрос
Код ответа	Переменная для сохранения кода HTTP-ответа
Заголовки ответа	Переменная для сохранения заголовков HTTP-ответа. Возвращается JSON-объект
Ответ	Переменная для сохранения тела HTTP-ответа
Ошибка	Переменная для сохранения HTTP-кода или текста ошибки, не связанной с HTTP
Переход	Компонент, которому передается управление в случае успешного получения ответа
Переход, ошибка	Компонент, которому передается управление в случае ошибки отправки запроса, либо получения неудачного ответа(коды 4xx – 5xx), либо наступления таймаута

Название

Описание

Домен

Домен запроса. Если сценарий исполняется в мастер-домене, то запрос может выполняться в любом домене. Если сценарий исполняется в рабочем домене, то здесь можно указать либо сам домен, либо поддомен сценария.

Логин

Пользователь в домене для запроса. Можно указать любого пользователя, и он должен существовать в домене запроса.

Метод

Возможные варианты: GET, POST, PATCH, PUT, DELETE

Путь

Путь запроса. Часть URL, следующая после схемы и имени хоста, исключая запрос. Например: https://cloud.oktell.studio/api/admin/v1/project/read?filter={"id":"345"} - полный URL, в котором /api/admin/v1/project/read - путь, а filter={"id":"345"} - запрос

Запрос

Запрос часть URL, следующая за знаком вопроса. Сам знак вопроса не пишется. Например: http://cloud.oktell.studio/api/admin/v1/project/read?filter={"id":"345"} - полный URL, в котором /api/admin/v1/project/read - путь, а filter={"id":"345"} - запрос

Заголовки

Подставляемые в запрос дополнительные HTTP-заголовки. Принимается JSON-объект либо заголовки построчно

Время, мс

Таймаут ожидания ответа на отправленный HTTP-запрос

Код ответа

Переменная для сохранения кода HTTP-ответа

Заголовки ответа

Переменная для сохранения заголовков HTTP-ответа. Возвращается JSON-объект

Ответ

Переменная для сохранения тела HTTP-ответа

Ошибка

Переменная для сохранения HTTP-кода или текста ошибки, не связанной с HTTP

Переход

Компонент, которому передается управление в случае успешного получения ответа

Переход, ошибка

Компонент, которому передается управление в случае ошибки отправки запроса, либо получения неудачного ответа(коды 4xx – 5xx), либо наступления таймаута