...
ExeMedia Service может использоваться сторонними клиентами для загрузки, обновления, удаления и получения истории файлов в ExeMES.
Вызов web API ExeMedia Service
Вызов web API ExeMES ExeMedia 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 ExeMedia Service
ExeMedia Service использует бесплатные инструменты Swagger в качестве встроенного инструмента документирования web API.
| Info |
|---|
Swagger — это набор инструментов, который позволяет автоматически описывать API на основе его кода. На основе кода Swagger автоматически генерирует документацию в формате JSON-файла. Ее можно встроить на страницу сайта или в приложение, чтобы пользователи могли интерактивно знакомиться с документацией. |
Документация по web API ExeMedia Service доступна в Swagger по адресу https://exemedia.[домен]/swagger/index.html. В интерфейсе swagger представлен список всех доступных web API функций ExeMedia Service с описанием.
| Expand | ||
|---|---|---|
| ||
Для получения информации о параметрах функции необходимо выбрать функцию в списке после чего откроется выпадающая область, в которой представлены все параметры функции. Также в выпадающей области можно вызвать функцию с заданными параметрами. Для этого сначала необходимо пройти процесс авторизации. Для авторизации в Swagger необходимо нажать на кнопку «Authorize», размещенную в правом верхнем углу основной страницы, после чего в открывшемся окне нажать на кнопку «Authorize». Далее вы будете перенаправлены на страницу входа и после успешного прохождения авторизации API функции будут доступны для вызова из Swagger. Swagger предоставляет информацию о назначении каждой функции и каждого параметра функции. Для вызова функции необходимо нажать на кнопку «Try it out» в выпадающей области, после чего задать необходимые параметры функции и нажать на кнопку «Execute». В случае успешного выполнения функции, возвращаемые функцией данные станут доступны в поле «Response body»: При неуспешном выполнении функции в Server response будет предоставлена информация об ошибке:
|
