Skip to content

Вход в систему

Apostol Developer edited this page Sep 25, 2021 · 3 revisions

Вход в систему по предоставленным данным от пользователя.

  • Обратите внимание, что наличие маркера доступа (пользователя) свидетельствует о том, что вход в систему уже был осуществлён.

  • Метод вызывается сервером авторизации при входе в систему. Вызов метода на прямую приведет к ошибке.

  • Для входа в систему используйте конечные точки сервера авторизации: Учётные данные владельца ресурса.

API

POST /api/v1/sign/in

Параметры:

Поле Тип Описание
username STRING Вариативный. Имя пользователя (Персональный код).
phone STRING Вариативный. Телефон.
email STRING Вариативный. Электронный адрес.
password STRING Вариативный. Пароль. Если username это персональный код, то в password нужно передать хеш SHA1(secret) от секретного кода пользователя.
agent STRING Игнорируется. Агент пользователя (браузер). Значение проставляется системой.
host STRING Игнорируется. IP адрес. Значение проставляется системой.

Варианты:

  • <username> <password>
  • <phone> <password>
  • <email> <password>

Описание ответа:

Поле Тип Описание
session STRING Код сессии.
code STRING Код авторизации для получения маркера доступа по протоколу OAuth 2.0.
secret STRING Секретный ключ (не путать с секретным кодом пользователя) для подписи методом HMAC-SHA256.

Пример:

Запрос:

POST /api/v1/sign/in HTTP/1.1
Host: localhost:8080
Content-Type: application/json

{"username": "user", "password": "user"}

Ответ (положительный):

{
  "session":"149d2ae6fa3f82eda21f7dba21824f199d508343",
  "code":"0s4mI+o6tKbubsOirzgxl24/SVoWI8L3ruJYUz/J0+SjbnW12oF9kVe1B642Uw8P",
  "secret":"pkPm5zmHKj04Xr/NH1nKr6ZEUqOfyacC79HLFIQTrBgA6ApbgBvGiJlMBy4XBApt"
}

Ответ (отрицательный):

{"error": {"code": 401, "message": "Вход в систему невозможен. Проверьте правильность имени пользователя и повторите ввод пароля."}}
Clone this wiki locally