Saltar al contenido principal
Este documento presentará una verificación de dos factores del número de teléfono API, que se puede utilizar para verificar la autenticidad y consistencia del número de teléfono y el nombre.

Proceso de solicitud

Para utilizar la API, primero debe ir a la página correspondiente de Verificación de dos factores del número de teléfono API para solicitar el servicio correspondiente. Una vez en la página, haga clic en el botón “Acquire”, como se muestra en la imagen: Si aún no ha iniciado sesión o registrado, será redirigido automáticamente a la página de inicio de sesión que le invita a registrarse e iniciar sesión. Después de iniciar sesión o registrarse, volverá automáticamente a la página actual. En la primera solicitud, se le otorgará un límite gratuito que le permitirá utilizar la API de forma gratuita.

Uso básico

Primero, comprenda la forma básica de uso, que consiste en ingresar el número de teléfono para obtener el resultado procesado. Primero, necesita pasar un campo mobile. A continuación, podemos completar el contenido correspondiente en la interfaz, como se muestra en la imagen:

Aquí podemos ver que hemos configurado los encabezados de la solicitud, que incluyen:
  • accept: el formato de respuesta que desea recibir, aquí se establece como application/json, es decir, formato JSON.
  • authorization: la clave para llamar a la API, que puede seleccionar directamente después de solicitar.
Además, se configuró el cuerpo de la solicitud, que incluye:
  • name: el nombre del usuario que necesita ser procesado, es un parámetro obligatorio.
  • mobile: el número de teléfono que necesita ser procesado, es un parámetro obligatorio.
  • encryption: opcional, parámetro de cifrado de campos sensibles (si necesita enviar texto cifrado).
Después de seleccionar, puede notar que también se generó el código correspondiente a la derecha, como se muestra en la imagen:

Haga clic en el botón “Try” para realizar la prueba, como se muestra en la imagen anterior, aquí obtuvimos el siguiente resultado:
{
  "result": "0",
  "description": "El resultado de la verificación es consistente"
}
El resultado devuelto tiene varios campos, que se describen a continuación:
  • result, código de resultado de autenticación, la situación de cobro es la siguiente.
    • Códigos de resultado de cobro:
      • 0: El resultado de la verificación es consistente
      • 1: El resultado de la verificación no es consistente
    • Códigos de resultado sin cobro:
      • -1: No se encontraron registros
      • -2: Error desconocido del motor
      • -3: Servicio del motor anómalo
      • -4: Verificación del nombre no aprobada
      • -5: Número de teléfono no válido
      • -6: El número de intentos de autenticación ha superado el límite diario, por favor intente de nuevo al día siguiente
  • description, descripción del resultado del negocio.
Se puede ver que la autenticidad y consistencia del número de teléfono y el nombre ya han sido consultadas. Además, si desea generar el código de integración correspondiente, puede copiarlo directamente, por ejemplo, el código de CURL es el siguiente:
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": "***"
}'
El código de integración en Python es el siguiente:
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)

Manejo de errores

Al llamar a la API, si encuentra un error, la API devolverá el código de error y la información correspondiente. Por ejemplo:
  • 400 token_mismatched: Solicitud incorrecta, posiblemente debido a parámetros faltantes o inválidos.
  • 400 api_not_implemented: Solicitud incorrecta, posiblemente debido a parámetros faltantes o inválidos.
  • 401 invalid_token: No autorizado, token de autorización inválido o faltante.
  • 429 too_many_requests: Demasiadas solicitudes, ha superado el límite de tasa.
  • 500 api_error: Error interno del servidor, algo salió mal en el servidor.

Ejemplo de respuesta de error

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "la recuperación falló"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

Conclusión

A través de este documento, ha aprendido cómo utilizar la API de verificación de dos factores del número de teléfono para verificar la autenticidad y consistencia del número de teléfono y el nombre. Esperamos que este documento le ayude a integrar y utilizar mejor esta API. Si tiene alguna pregunta, no dude en ponerse en contacto con nuestro equipo de soporte técnico.