| Note |
|---|
Доступно начиная с версии ExeMES 2.4 |
| Info |
|---|
ExeMedia ExeMES Media Service - это сервис сервис для работы с файлами в ExeMES. API ExeMedia ExeMES Media Service предоставляют следующие возможности:
|
ExeMedia ExeMES Media Service используется используется ExeMES Client и ExeMES RuntimeClient. ExeMedia ExeMES Media Service также может использоваться сторонними приложениями путем вызова web API.
| Note |
|---|
Вызов web API возможен при наличии у пользователя, под которым производится вызов функции, соответствующего доступа |
Вызов web API
...
ExeMES Media Service
Вызов web API ExeMedia ExeMES Media Service можно реализовывать различными способами в зависимости от способов и методов реализации на стороне клиентских приложений.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://exemedia.[домен]/api/Files");
var accessToken = "token"; // здесь необходимо задать Access Token, полученный от KeyCloak
request.Headers.Add("Authorization", $"Bearer {accessToken}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync()); |
Документация по web
...
API ExeMES Media Service
ExeMedia ExeMES Media Service использует бесплатные инструменты Swagger в качестве встроенного инструмента документирования web API.
| Info |
|---|
Swagger — это набор инструментов, который позволяет автоматически описывать API на основе его кода. На основе кода Swagger автоматически генерирует документацию в формате JSON-файла. Ее можно встроить на страницу сайта или в приложение, чтобы пользователи могли интерактивно знакомиться с документацией. |
Документация по web API ExeMedia ExeMES Media Service доступна в Swagger по адресу https://exemedia.[домен]/swagger/index.html. В интерфейсе swagger представлен список всех доступных web API функций ExeMedia ExeMES Media Service с описанием.
| Expand | ||
|---|---|---|
| ||
Для получения информации о параметрах функции необходимо выбрать функцию в списке после чего откроется выпадающая область, в которой представлены все параметры функции. Также в выпадающей области можно вызвать функцию с заданными параметрами. Для этого сначала необходимо пройти процесс авторизации. Для авторизации в Swagger необходимо нажать на кнопку «Authorize», размещенную в правом верхнем углу основной страницы, после чего в открывшемся окне нажать на кнопку «Authorize». Далее вы будете перенаправлены на страницу входа и после успешного прохождения авторизации API функции будут доступны для вызова из Swagger. Swagger предоставляет информацию о назначении каждой функции и каждого параметра функции. Для вызова функции необходимо нажать на кнопку «Try it out» в выпадающей области, после чего задать необходимые параметры функции и нажать на кнопку «Execute». В случае успешного выполнения функции, возвращаемые функцией данные станут доступны в поле «Response body»: При неуспешном выполнении функции в Server response будет предоставлена информация об ошибке:
|
...