# Авторизация и режимы работы с API

### Авторизация из локальной сети отеля

Авторизация выполняется от лица пользователя **admin** – метод авторизации **basic**.

Документация: [http://localhost:5001/api/docs/index.html](http://localhost:5001/api/docs/index.html)

Работа выполняется через локальный сервер отеля – задача по администрированию должна решатся системным администратором отеля.

Стандартный путь для обращения к API в локальной сети:

<span style="font-size: 14.0pt; font-family: 'Courier New';">&lt;АДРЕС СЕРВЕРА&gt;/api/&lt;ВЕРСИЯ&gt;/&lt;ЗАПРОС&gt;</span>

### Авторизация через облачный интеграционный шлюз

Авторизация выполняется через передачу **токена доступа** через HTTP заголовок **X-Api-Key**.

Документация: [https://webhub.edelink.ru/integrations/api-docs](https://webhub.edelink.ru/integrations/api-docs)

Взаимодействие с API выполняется через **сеть интернет** через облачный сервер по HTTPS.

Предоставление токенов авторизации и подключение отелей выполняется по запросу. Один токен позволяет работать как с одним так и с несколькими отелями.

Стандартный путь для обращения к API через интеграционный шлюз:

**<span style="font-size: 11.0pt; font-family: 'Arial',sans-serif; mso-fareast-language: EN-US;"> </span>**<span style="font-size: 14.0pt; font-family: 'Courier New';">&lt;АДРЕС СЕРВЕРА&gt;/api/gw/{agentId}/&lt;ВЕРСИЯ&gt;/&lt;ЗАПРОС&gt;</span>

### Способ возврата ошибок

Для возврата ошибок используется Problem Details – RFC 7807: [https://datatracker.ietf.org/doc/html/rfc7807](https://datatracker.ietf.org/doc/html/rfc7807)

- Об <span style="color: rgb(45, 194, 107);">**успехе** </span>сообщают двухсотые HTTP коды (200, 201 и т.д.);
- Об <span style="color: rgb(224, 62, 45);">**ошибках** </span>сообщают четырехсотые и пятисотые HTTP коды (400, 401, 404, 500 и т.д.)

Человеко-читаемое сообщение об ошибке можно получить из поля **detail**.

Часть методов может возвращать дополнительные сведения (например, поле appStatusCode которое позволяет получить машино-читаемый код ошибки).

### Способ проверки работоспособности сервера

<span style="font-size: 11.0pt; font-family: 'Arial',sans-serif; mso-fareast-language: EN-US;">При работе через облачный шлюз проверить работоспособность сервера можно методом </span><span lang="EN-US" style="font-size: 11.0pt; font-family: 'Arial',sans-serif; mso-ansi-language: EN-US; mso-fareast-language: EN-US;">ping</span><span style="font-size: 11.0pt; font-family: 'Arial',sans-serif; mso-fareast-language: EN-US;"> ([GET](https://webhub.edelink.ru/integrations/api-docs#tag/system/GET/api/gw/{agentId}/v1/system/ping "GET")</span><span style="font-size: 11.0pt; font-family: 'Arial',sans-serif; mso-fareast-language: EN-US;"> или [POST](https://webhub.edelink.ru/integrations/api-docs#tag/system/POST/api/gw/{agentId}/v1/system/ping "POST")</span><span style="font-size: 11.0pt; font-family: 'Arial',sans-serif; mso-fareast-language: EN-US;">)</span>

- <span style="font-size: 11.0pt; font-family: 'Arial',sans-serif; mso-fareast-language: EN-US;">Код 200 значит, что интеграционный модуль работает и доступен.</span>
- <span style="font-size: 11.0pt; font-family: 'Arial',sans-serif; mso-fareast-language: EN-US;">Код 503 (Service Unavailable) значит, что интеграционный модуль **не работает** (например, остановлен) .</span>

<span style="font-size: 11.0pt; font-family: 'Arial',sans-serif; mso-fareast-language: EN-US;">Пример ответа на запрос, когда сервер доступен:</span>

[![image.png](https://help.edelink.ru/uploads/images/gallery/2026-09/scaled-1680-/vVoimage.png)](https://help.edelink.ru/uploads/images/gallery/2026-09/vVoimage.png)