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

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

Чтобы использовать API, сначала необходимо перейти на соответствующую страницу API проверки трех элементов номера телефона и подать заявку на соответствующую услугу. После перехода на страницу нажмите кнопку «Acquire», как показано на изображении: Если вы еще не вошли в систему или не зарегистрированы, вас автоматически перенаправят на страницу входа, чтобы пригласить вас зарегистрироваться и войти в систему. После входа или регистрации вы автоматически вернетесь на текущую страницу. При первой подаче заявки будет предоставлен бесплатный лимит, который можно использовать для бесплатного доступа к этому API.

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

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

Как видно, здесь мы настроили заголовки запроса, включая:
  • accept: в каком формате вы хотите получить ответ, здесь указано application/json, то есть в формате JSON.
  • authorization: ключ для вызова API, который можно выбрать из выпадающего списка после подачи заявки.
Также настроено тело запроса, включая:
  • name: имя пользователя, которое необходимо обработать, является обязательным параметром.
  • phone: номер телефона, который необходимо обработать, является обязательным параметром.
  • id_card: номер удостоверения личности пользователя, который необходимо обработать, является обязательным параметром.
  • verify_mode: режим проверки (длинный/короткий).
  • encrypt_list/ciphertext_blob/iv: необязательные параметры шифрования, шифруйте чувствительные поля по мере необходимости.
После выбора можно заметить, что справа также сгенерирован соответствующий код, как показано на изображении:

Нажмите кнопку «Try», чтобы провести тестирование, как показано на изображении выше, и мы получили следующий результат: 
{
  "result": "0",
  "description": "Аутентификация пройдена",
  "isp": "Мобильный",
  "result_detail": null
}
Возвращаемый результат содержит несколько полей, описание которых приведено ниже:
  • result, код результата аутентификации, условия оплаты следующие.
    • Платные коды результата:
      • 0: Результат проверки совпадает
      • 1: Результат проверки не совпадает
    • Бесплатные коды результата:
      • -1: Запись не найдена
      • -2: Неизвестная ошибка движка
      • -3: Аномалия в работе сервиса движка
      • -4: Проверка имени не пройдена
      • -5: Номер телефона недействителен
      • -6: Количество аутентификаций превышает дневной лимит, попробуйте снова на следующий день
  • description, описание бизнес-результата.
Можно увидеть, что информация о подлинности и согласованности номера телефона, имени и номера удостоверения личности уже была запрошена. Кроме того, если вы хотите сгенерировать соответствующий код интеграции, вы можете просто скопировать его, например, код CURL выглядит следующим образом: 
curl -X POST 'https://api.acedata.cloud/identity/phone/check-3e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "name": "***",
  "phone": "***",
  "id_card": "***"
}'
Код интеграции на Python выглядит следующим образом: 
import requests

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

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

payload = {
    "name": "***",
    "phone": "***",
    "id_card": "***"
}

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. Если у вас есть какие-либо вопросы, пожалуйста, не стесняйтесь обращаться в нашу техническую поддержку.