Пример curl-запроса на авторизацию:
curl --location --requestPOST 'http://cloud.dvor24.com/api/v2/auth/login?login=ЛОГИН-ОТ-ЛИЧНОГО-КАБИНЕТА&password=ПАРОЛЬ-ОТ-ЛИЧНОГО-КАБИНЕТА'
Авторизация для API в сервисе cloud.dvor24.com может быть произведена двумя способами:
Стандартными заголовками являются x-vsaas-api-key и x-vsaas-session, где передается api-key пользователя и токен сессии авторизации соответственно. Для получения этих данных используется следующий запрос:
POST/api/v2/auth/login
| Ключ | Тип | Описание |
|---|---|---|
| login | string | логин |
| password | string | пароль |
| Ключ | Тип | Описание |
|---|---|---|
| id | integer | идентификатор пользователя |
| login | string | логин |
| sid | string | тип учетной записи |
| hash | string | хэш |
| cityId | integer | идентификатор города |
| authToken | string | токен авторизации |
| regionData | object | информация о регионе |
| countryId | integer | идентификатор страны |
| countryPrefix | string | префикс страны |
| regionPrefix | string | префикс региона |
| regionId | integer | идентификатор региона |
| apiKey | string | ключ API |
| isActivation | boolean | используется для определения статуса активации пользователя (актуально для типа пользователя client) |
curl -X POST https://api.dvor24.com/api/v2/auth/login -d "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: ***"
Сервисный заголовок (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: ***"