NCARepository
Документация для класса NCARepository.
Методы
signIn
Описание
Метод для авторизации пользователя с использованием ECP. Отправляет запрос с ECP и возвращает токен для авторизации.
HTTP метод: POST
URL: /api/v1/auth/login/ecp
Параметры:
| Имя | Тип | Описание |
|---|---|---|
ecp | string |
Возвращает: Promise<ISignInECPResponse>
saveECP
Описание
Метод для сохранения ECP на сервере. Отправляет запрос с ECP и именем для сохранения.
HTTP метод: POST
URL: http://127.0.0.1:3010/api/nca/keys
Параметры:
| Имя | Тип | Описание |
|---|---|---|
payload | ISaveECPPayload |
Возвращает: Promise<void>
getTestECP
Описание
Метод для получения тестовых ECP. Отправляет запрос на сервер для получения списка тестовых ECP.
HTTP метод: GET
URL: http://127.0.0.1:3010/api/nca/keys
Параметры: Нет
Возвращает: Promise<ITestECP[]>
signUp
Описание
Метод для регистрации пользователя через NCA. Отправляет запрос с ECP и возвращает информацию о зарегистрированном пользователе.
HTTP метод: POST
URL: /api/v1/auth/register
Параметры:
| Имя | Тип | Описание |
|---|---|---|
payload | ISignUpByNCARequest |
Возвращает: Promise<ISignUpByNCAResponse>
Определения типов
Определения интерфейсов, перечислений и псевдонимов типов, используемых в методах этого репозитория.
INCARepository
Интерфейс не содержит собственных свойств и не наследует другие локальные интерфейсы.
ISaveECPPayload
| Свойство | Тип | Описание |
|---|---|---|
ecp | string | |
name | string |
ISignInECPResponse
| Свойство | Тип | Описание |
|---|---|---|
token | string |
ISignUpByNCARequest
| Свойство | Тип | Описание |
|---|---|---|
ecp | string |
ISignUpByNCAResponse
| Свойство | Тип | Описание |
|---|---|---|
uuid | string | |
ecp_email | string | null | |
current_email | string | null | |
subject_name | string | |
subject_type | ESubjectTypeAlias |
ITestECP
| Свойство | Тип | Описание |
|---|---|---|
name | string | |
created | string | |
key | string |