Авторизация


Авторизация для API в сервисе cloud.dvor24.com может быть произведена двумя способами:

Стандартные заголовки

Стандартными заголовками являются x-vsaas-api-key и x-vsaas-session, где передается api-key пользователя и токен сессии авторизации соответственно. Для получения этих данных используется следующий запрос:

POST/api/v2/auth/login

Параметры:
КлючТипОписание
loginstringлогин
passwordstringпароль
Ответ:
КлючТипОписание
idintegerидентификатор пользователя
loginstringлогин
sidstringтип учетной записи
hashstringхэш
cityIdintegerидентификатор города
authTokenstringтокен авторизации
regionDataobjectинформация о регионе
countryIdintegerидентификатор страны
countryPrefixstringпрефикс страны
regionPrefixstringпрефикс региона
regionIdintegerидентификатор региона
apiKeystringключ API
isActivationbooleanиспользуется для определения статуса активации пользователя (актуально для типа пользователя client)
curl -X POST https://api.dvor24.com/api/v2/auth/login -d "login=***&password=***".
await fetch("https://api.dvor24.com/api/v2/auth/login", { method: "POST", body: JSON.stringify({ login: "***", password: "***" })})

После получения данных авторизации следует сохранить параметры apiKey и authToken. При использовании других методов API эти данные будут подставляться в заголовки x-vsaas-api-key и x-vsaas-session соответственно.

Пример получения камеры пользователя:

curl https://api.dvor24.com/api/v2/cameras/{name} -H "x-vsaas-api-key: ***" -H "x-vsaas-session: ***"
await fetch("https://api.dvor24.com/api/v2/cameras/{name}", { headers: { "x-vsaas-api-key": "***", "x-vsaas-session": "***" }})

Сервисный заголовок

Сервисный заголовок (x-vsaas-service-api-key) позволяет работать с API, без прохождения предварительной авторизации (работает только если тип пользователя partner). Для того чтобы получить данный ключ следует создать его в панели управления cloud.dvor24.com. Для этого заходим в Настройки > Профиль > вкладка API. После того как токен будет создан им можно будет сразу же начать пользоваться для всех запросов API.

Пример получения камеры пользователя:

curl https://api.dvor24.com/api/v2/cameras/{name} -H " x-vsaas-service-api-key: ***"
await fetch("https://api.dvor24.com/api/v2/cameras/{name}", { headers: { "x-vsaas-service-api-key": "***" }})