Token2 API
Token2 API - это RESTful API для подключение двух-факторной аутентификации пользователей на веб-сайте или веб-приложении. Чтобы начать использовать Token2 API, нужно создать аккаунт и добавить ваш сайт. Token2 сгенерирует API ключ для вашего сайта..
У нас есть
примеры использования Token2 API для разных языков программирования (таких как PHP и C#), а также
плагины для подключения WordPress и Drupal.
Создание пользователя
Вызов этого API создает пользователя и возвращает уникальный ID и секретный ключ для активируемого пользователя.
https://api.token2.com/createuser?api
=[api_key]&phone
=[mobile_phone]&email
=[email]&type
=[authentication type]&pin
=[pin code]&format
=[response format]
Агрументы, которые нужно передать при вызове API:
api
- API ключ веб-сайта. Его можно получить нажав на название сайта в панели управления
phone
- номер мобильного телефона юзера в формате e.164. Этот номер будет использован при отправке OTP через SMS или сброса настроек мобильного приложения Token2
email
- адрес почты пользователя
type
- Тип аутентификации. Возможны следующие значения: 0 - только через мобильное приложение(по умолчанию), 1 - Через SMS , 2 - Через email (для тестирования, не рекомендуется использовать в режиме эксплуатации )
pin
- пин-код, установленный пользователем
format
- формат данных. Значения: 1- json, 2- xml, 3- упрощенная, обычный текст (true или false, без деталей и описания), 0- формат serialized data (по умолчанию)
Ответ
Вызов возвращает данные в результате успешного выполнения:
response
- описание результата на английском (например "user created", то есть пользователь добавлен)
userid
- уникальный ID пользователя. Этот ID должен хранится в базе данных сайта для сопоставления с базой данных Token2. ID пользователя требуется для валидации, генерации и отправки одноразовых паролей.
success
- возвращает "true" если пользователь был успешно добавлен и ему был присвоен уникальный ID
hash
- уникальный секретный ключ, который будет добавлен в мобильное приложение пользователя Token2 Mobile Application
hashqr
- Картинка с QR code, с адресом секретного ключа пользователя, которая должна быть просканирована пользователем из мобильного приложения Token2 Mobile Application при регистрации на сайте.
Валидация одноразовых паролей
API валидации, проверяет одноразовый пароль, предоставленный пользователем.
https://api.token2.com/validate?api
=[api key]&token
=[token]&userid
=[User's Token2 ID]
Агрументы, которые нужно передать при вызове API:
api
- API ключ веб-сайта. Его можно получить нажав на название сайта в панели управления
userid
- Уникальный ID пользователя.
token
- одноразовый пароль
Ответ
Данные возвращаемые при успешном выполнении:
response
- результат ответа на английском (например "OTP generated and sent by SMS")
userid
- Token2 ID пользователя
siteid
- ID веб-сайта
validation
- возвращает "true" если одноразовый пароль действительный и прошел проверку, или "false" если не прошел. Используйте эти значения для подтверждения аутентификации.
Генерация и отправка одноразовых паролей по SMS
Этот API вызов используется для аутентификации через SMS.
https://api.token2.com/send?api
=[api key]&userid
=[User's Token2 ID]
Агрументы, которые нужно передать при вызове API:
api
- API ключ веб-сайта. Его можно получить нажав на название сайта в панели управления
userid
- Token2 ID пользователя.
Ответ
Данные возвращаемые при успешном выполнении:
response
- результат ответа на английском (например "OTP generated and sent by SMS")
userid
- Token2 ID пользователя
siteid
- ID веб-сайта
success
- возвращает "true" если одноразовый пароль был успешно сгенерирован и отправлен пользователю.