Підтвердити користувача

POST 
/auth/login

Для використання API Butler Smart Home вам потрібно отримати доступ та оновлювальний токен. Цей виклик використовує заголовок Авторизація з схемою авторизації Basic, щоб отримати ім'я користувача та пароль. Після успішної аутентифікації ви отримаєте доступ і оновлені токени. Токен доступу використовується для автентифікації всіх інших викликів API, а токен оновлення використовується для отримання нового токену доступу, коли старий закінчується.

Request

application/json

Body

client

object

Опис клієнта для пуш-сповіщень.

idstring

Унікальний ідентифікатор клієнта, створений у більшості випадків мобільною програмою

Example: 123h9423HKUIJwss-gfwve

namestring

Натисніть на ім'я клієнта, яке також створено за допомогою мобільної програми

Example: Мій телефон

typestring

Тип клієнта Push. Можливі значення: android, ios, інше

Possible values: [android, ios, other]

Example: android

push_typestring

Тип сповіщення push. Можливі значення: Будь-який, Система, Сцени, Безпека

Possible values: [Any, System, Scenes, Security]

Example: Any

push_tokenstring

Отримано токен PUSH мобільним додатком від Firebase.

Example: f1r3b4s3t0k3n

Responses

200

Успішно автентифіковано.

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

refresh_tokenstringrequired

Оновити токен для автентифікованого користувача

tokenstringrequired

Маркер доступу для автентифікованого користувача

resultstringrequired
Результат автентифікації
Possible values: [ok]
Example: ok

client

object

Стисніть список клієнтів

idstring

Унікальний ідентифікатор клієнта, створений у більшості випадків мобільною програмою

Example: 123h9423HKUIJwss-gfwve

namestring

Натисніть на ім'я клієнта, яке також створено за допомогою мобільної програми

Example: Мій телефон

typestring

Тип клієнта Push. Можливі значення: android, ios, інше

Possible values: [android, ios, other]

Example: android

push_typestring

Тип сповіщення push. Можливі значення: Будь-який, Система, Сцени, Безпека

Example (from schema)

{
  "success": true,
  "refresh_token": "string",
  "token": "string",
  "result": "ok",
  "client": {
    "id": "123h9423HKUIJwss-gfwve",
    "name": "Мій телефон",
    "type": "android",
    "push_type": "string"
  }
}

401

Не підтверджено

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

errorCodeintegerrequired

Ціле число помилки, див. Помилки

errorMessagestringrequired

Опис помилки

errorParameters

Додаткові дані, що описують помилку

Example (from schema)

{
  "success": true,
  "errorCode": 0,
  "errorMessage": "string"
}