twofa.php¶

Модуль управления двухфакторной аутентификацией: настройка методов (TOTP, Email, SMS, None) и верификация кодов.

Методы API¶

Метод	Действие	Описание
`send_email_code`	отправка кода на email	Инициирует отправку одноразового кода подтверждения на указанный адрес электронной почты.
`send_sms_code`	отправка кода по SMS	Инициирует отправку одноразового кода подтверждения на номер телефона пользователя.
`set_method_email`	установка метода Email	Устанавливает электронную почту в качестве основного метода двухфакторной аутентификации.
`set_method_none`	отключение 2FA	Отключает двухфакторную аутентификацию (устанавливает метод 'None').
`set_method_sms`	установка метода SMS	Устанавливает SMS-сообщения в качестве основного метода двухфакторной аутентификации.
`set_method_totp`	установка метода TOTP	Устанавливает использование приложений-аутентификаторов (TOTP) в качестве основного метода 2FA.
`verify_code`	верификация кода	Проверяет введенный код для подтверждения личности пользователя.
`verify_email_code`	верификация email-кода	Проверяет введенный код, отправленный на электронную почту пользователя.
`verify_sms_code`	верификация SMS-кода	Проверяет введенный код, отправленный через SMS.
`verify_totp_code`	верификация TOTP-кода	Проверяет одноразовый код из приложения (Google Authenticator, Authy и др.).

twofa/send_email_code¶

Инициирует отправку одноразового кода подтверждения на указанный адрес электронной почты.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `send_email_code`
token	✅	string	Токен авторизации пользователя.

Пример запроса

curl -s "https://invapi.hostkey.ru/twofa.php" -X POST \
--data "action=send_email_code" \
--data "token=HOSTKEY_TOKEN"

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

{
"result": "OK",
"action": "send_email_code",
"data": {
"status": "sent",
"email": "user@example.com"
}
}

Примеры ошибок

{
"code": -1,
"message": "Action required"
}

twofa/send_sms_code¶

Инициирует отправку одноразового кода подтверждения на номер телефона пользователя.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `send_sms_code`
token	✅	string	Токен авторизации пользователя.

Пример запроса

curl -s "https://invapi.hostkey.ru/twofa.php" -X POST \
--data "action=send_sms_code" \
--data "token=HOSTKEY_TOKEN"

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

{
"result": "OK",
"action": "send_sms_code",
"data": {
"status": "sent",
"phone": "+79991234567"
}
}

Примеры ошибок

{
"code": -1,
"message": "Action required"
}

twofa/set_method_email¶

Устанавливает электронную почту в качестве основного метода двухфакторной аутентификации.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `set_method_email`
token	✅	string	Токен авторизации пользователя.

Пример запроса

curl -s "https://invapi.hostkey.ru/twofa.php" -X POST \
--data "action=set_method_email" \
--data "token=HOSTKEY_TOKEN"

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

{
"result": "OK",
"action": "set_method_email",
"data": {
"method": "email",
"active": true
}
}

Примеры ошибок

{
"code": -1,
"message": "Action required"
}

twofa/set_method_none¶

Отключает двухфакторную аутентификацию (устанавливает метод 'None').

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `set_method_none`
token	✅	string	Токен авторизации пользователя.

Пример запроса

curl -s "https://invapi.hostkey.ru/twofa.php" -X POST \
--data "action=set_method_none" \
--data "token=HOSTKEY_TOKEN"

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

{
"result": "OK",
"action": "set_method_none",
"data": {
"method": "none",
"active": false
}
}

Примеры ошибок

{
"code": -1,
"message": "Action required"
}

twofa/set_method_sms¶

Устанавливает SMS-сообщения в качестве основного метода двухфакторной аутентификации.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `set_method_sms`
token	✅	string	Токен авторизации пользователя.

Пример запроса

curl -s "https://invapi.hostkey.ru/twofa.php" -X POST \
--data "action=set_method_sms" \
--data "token=HOSTKEY_TOKEN"

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

{
"result": "OK",
"action": "set_method_sms",
"data": {
"method": "sms",
"active": true
}
}

Примеры ошибок

{
"code": -1,
"message": "Action required"
}

twofa/set_method_totp¶

Устанавливает использование приложений-аутентификаторов (TOTP) в качестве основного метода 2FA.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `set_method_totp`
token	✅	string	Токен авторизации пользователя.

Пример запроса

curl -s "https://invapi.hostkey.ru/twofa.php" -X POST \
--data "action=set_method_totp" \
--data "token=HOSTKEY_TOKEN"

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

{
"result": "OK",
"action": "set_method_totp",
"data": {
"method": "totp",
"active": true,
"secret": "JBSWY3DPEHPK3PXP"
}
}

Примеры ошибок

{
"code": -1,
"message": "Action required"
}

twofa/verify_code¶

Проверяет введенный код для подтверждения личности пользователя.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `verify_code`
token	✅	string	Токен авторизации пользователя.

Пример запроса

curl -s "https://invapi.hostkey.ru/twofa.php" -X POST \
--data "action=verify_code" \
--data "token=HOSTKEY_TOKEN"

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

{
"result": "OK",
"action": "verify_code",
"data": {
"verified": true
}
}

Примеры ошибок

{
"code": -1,
"message": "Invalid code"
}

twofa/verify_email_code¶

Проверяет введенный код, отправленный на электронную почту пользователя.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `verify_email_code`
token	✅	string	Токен авторизации пользователя

Пример запроса

curl -s "https://invapi.hostkey.ru/twofa.php" -X POST \
--data "action=verify_email_code" \
--data "token=HOSTKEY_TOKEN"

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

{
"result": "OK",
"action": "verify_email_code",
"data": {
"status": "verified",
"session_id": 123456789
}
}

Примеры ошибок

{
"code": -1,
"message": "Action required"
}

twofa/verify_sms_code¶

Проверяет введенный код, отправленный через SMS.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `verify_sms_code`
token	✅	string	Токен авторизации пользователя

Пример запроса

curl -s "https://invapi.hostkey.ru/twofa.php" -X POST \
--data "action=verify_sms_code" \
--data "token=HOSTKEY_TOKEN"

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

{
"result": "OK",
"action": "verify_sms_code",
"data": {
"status": "verified",
"session_id": 987654321
}
}

Примеры ошибок

{
"code": -1,
"message": "Action required"
}

twofa/verify_totp_code¶

Проверяет одноразовый код из приложения (Google Authenticator, Authy и др.).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `verify_totp_code`
token	✅	string	Токен авторизации пользователя

Пример запроса

curl -s "https://invapi.hostkey.ru/twofa.php" -X POST \
--data "action=verify_totp_code" \
--data "token=HOSTKEY_TOKEN"

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

{
"result": "OK",
"action": "verify_totp_code",
"data": {
"status": "verified",
"session_id": 556677889
}
}

Примеры ошибок

{
"code": -1,
"message": "Action required"
}