Авторизация клиента

Метод используется для авторизации клиента в системе. В ответе возвращается токен доступа и токен для обновления (refresh token), которые необходимы для последующих запросов к API.

Описание конечной точки

Метод используется для авторизации клиента в системе. В ответе возвращается токен доступа и токен для обновления (refresh token), которые необходимы для последующих запросов к API.

---

Запрос: Авторизация

URL: POST /auth/sign-in

Теги: auth

Описание: Авторизация клиента с использованием учетных данных (email, одноразового пароля или обычного пароля).

Пример запроса (cURL):

curl -X 'POST' \
  'https://api.client.nbcgate.tech/auth/sign-in' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "[e-mail]",
  "otp": "123456",
  "password": "yourpassword"
}'

---

Тело запроса:

Поле	Тип	Обязательное	Описание	Пример значения
email	string	Да	Электронная почта пользователя	[e-mail]
otp	string	Нет	Одноразовый пароль (если используется)	123456
password	string	Нет	Пароль пользователя	yourpassword

Примечание: Обязательно укажите либо otp, либо password, в зависимости от используемого метода авторизации.

---

Пример успешного ответа:

Код ответа: 200 OK

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refreshToken": "dXNlcl9yZWZyZXNoX3Rva2Vu..."
}

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

Поле	Тип	Описание	Пример значения
token	string	Токен доступа, используемый для авторизации в API	eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
refreshToken	string	Токен для обновления доступа	dXNlcl9yZWZyZXNoX3Rva2Vu...

---

Коды ответа:

Код ответа	Описание	Возможные причины
200	Успешная авторизация	Корректные учетные данные
400, 404	Неверный запрос или пользователь не найден	Ошибка в параметрах запроса
500	Внутренняя ошибка сервера	Проблемы на стороне сервера
default	Неизвестная ошибка	Требуется уточнение причин