Подключение к API

Приложения

Для того чтобы вы могли получать данные из DOMIC+ вам необходимо зарегистрировать свое приложение и получить токен доступа.

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

Вашему приложению сразу будет выдан токен доступа, однако он будет изначально недоступен. Вам нужно будет дождаться подтверждения вашего приложения администратором, после этого токен станет активным и вы сможете его использовать для получения данных.

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

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

Длительность сессии указывается в минутах. Если поле оставить пустым, то токен будет действителен всегда до момента выхода из системы.

Токен доступа

Для доступа к API DOMIC+ вам в обязательном порядке с каждым запросом нужно передавать следующий заголовок:

"X-Access-Token": "TOKEN"

где TOKEN - активный токен вашего приложения.

Если токен доступа не будет передан при запросе к любому маршруту, вы получите следующий ответ:

// 401 Unauthorized

{
    "message": "Не передан токен доступа"
}

Здесь и далее, строка // ... в начале ответа указывает на код ответа от сервера, если ее нет, значит код 200 OK.

И такую, если токен недействителен или неактивен:

// 403 Forbidden

{
    "message": "Неверный токен доступа"
}

Токен авторизации

Авторизация в приложении выполняется с помощью Bearer токена. Нужно установить следующий заголовок для запросов:

"Authorization": "Bearer TOKEN"

где TOKEN - токен авторизации пользователя, полученный при входе в систему.

Все маршруты описанные ниже защищены от не авторизированного доступа, кроме маршрута для входа в систему (/auth/login). Если токен не передан, некорректный или он истек вы получите следующую ошибку:

// 401 Unauthorized

{
    "message": "Вы не авторизованы в системе"
}