Проверка двухфакторной аутентификации по номеру телефона API Инструкция по интеграции

В этой статье будет представлена инструкция по интеграции API проверки двухфакторной аутентификации по номеру телефона, которая может использоваться для проверки подлинности и согласованности номера телефона и имени.

Процесс подачи заявки

Чтобы использовать API проверки двухфакторной аутентификации по номеру телефона, сначала перейдите в консоль Ace Data Cloud, чтобы получить ваш API Token и сохранить его на всякий случай.

Если вы еще не вошли в систему или не зарегистрированы, вы будете автоматически перенаправлены на страницу входа, где вас пригласят зарегистрироваться и войти. После завершения вы будете автоматически возвращены на текущую страницу. Один API Token позволяет вызывать все сервисы платформы, не нужно отдельно запрашивать для каждого сервиса. При первом запросе предоставляется бесплатный лимит, чтобы вы могли попробовать бесплатно; если лимит исчерпан, вы можете пополнить общий баланс в консоли.

📘 Полная документация: API проверки двухфакторной аутентификации по номеру телефона →

Основное использование

Сначала ознакомьтесь с основным способом использования, который заключается в том, что вы вводите номер телефона и получаете обработанный результат, для этого необходимо просто передать поле mobile. Далее мы можем заполнить соответствующие данные на интерфейсе, как показано на рисунке:

Как видно, мы настроили заголовки запроса, включая:

accept: в каком формате вы хотите получить ответ, здесь указано application/json, то есть в формате JSON.
authorization: ключ для вызова API, после запроса его можно выбрать из выпадающего списка.

Также настроено тело запроса, включая:

name: имя пользователя, которое необходимо обработать, является обязательным параметром.
mobile: номер телефона, который необходимо обработать, является обязательным параметром.
encryption: необязательный параметр, параметр шифрования для чувствительных данных (если необходимо отправить зашифрованный текст).

После выбора можно заметить, что справа также сгенерирован соответствующий код, как показано на рисунке:

Нажмите кнопку «Попробовать», чтобы провести тестирование, как показано на рисунке, здесь мы получили следующий результат:

{
  "result": "0",
  "description": "Результат проверки совпадает"
}

Возвращаемый результат содержит несколько полей, описание которых приведено ниже:

result, код результата аутентификации, условия оплаты следующие.
- Платные коды результата:
  - 0: Результат проверки совпадает
  - 1: Результат проверки не совпадает
- Бесплатные коды результата:
  - -1: Запись не найдена
  - -2: Неизвестная ошибка движка
  - -3: Аномалия в работе сервиса движка
  - -4: Проверка имени не прошла
  - -5: Номер телефона недействителен
  - -6: Превышено количество аутентификаций за день, попробуйте снова на следующий день
description, описание бизнес-результата.

Можно увидеть, что подлинность и согласованность номера телефона и имени уже проверены. Кроме того, если вы хотите сгенерировать соответствующий код интеграции, вы можете просто скопировать его, например, код CURL выглядит следующим образом:

curl -X POST 'https://api.acedata.cloud/identity/phone/check-2e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "name": "***",
  "mobile": "***"
}'

Код интеграции на Python выглядит следующим образом:

import requests

url = "https://api.acedata.cloud/identity/phone/check-2e"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "name": "***",
    "mobile": "***"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

Обработка ошибок

При вызове API, если возникнет ошибка, API вернет соответствующий код ошибки и информацию. Например:

400 token_mismatched: Неверный запрос, возможно, из-за отсутствующих или недействительных параметров.
400 api_not_implemented: Неверный запрос, возможно, из-за отсутствующих или недействительных параметров.
401 invalid_token: Неавторизован, недействительный или отсутствующий токен авторизации.
429 too_many_requests: Слишком много запросов, вы превысили лимит частоты.
500 api_error: Внутренняя ошибка сервера, что-то пошло не так на сервере.

Пример ответа об ошибке

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "не удалось получить данные"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

Заключение

С помощью этого документа вы узнали, как использовать API проверки двухфакторной аутентификации по номеру телефона для проверки подлинности и согласованности номера телефона и имени. Надеемся, что этот документ поможет вам лучше интегрировать и использовать данный API. Если у вас есть какие-либо вопросы, пожалуйста, не стесняйтесь обращаться в нашу техническую поддержку.

Начало работы

AI Чат

AI Изображение

AI Видео

AI Аудио

Веб и данные

CAPTCHA

Идентичность

Прокси

Продвинутый

Coding

Проверка двухфакторной аутентификации по номеру телефона API Инструкция по интеграции

Процесс подачи заявки

Основное использование

Обработка ошибок

Пример ответа об ошибке

Заключение

​Процесс подачи заявки

​Основное использование

​Обработка ошибок

​Пример ответа об ошибке

​Заключение

Процесс подачи заявки

Основное использование

Обработка ошибок

Пример ответа об ошибке

Заключение