> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Verificación de los tres elementos del número de teléfono API Integración

> Identity Authentication 集成指南 - XHuoAPI

Este documento presentará una descripción de la integración de la API de verificación de los tres elementos del número de teléfono, que se puede utilizar para verificar la autenticidad y consistencia del número de teléfono, nombre y número de identificación.

## Proceso de Solicitud

Para utilizar la API, primero debe ir a la página correspondiente de la [API de verificación de los tres elementos del número de teléfono](https://api.xhuoapi.ai/documents/b4c50108-dda5-4ddb-ba84-776060fb0151) para solicitar el servicio correspondiente. Una vez en la página, haga clic en el botón "Acquire", como se muestra en la imagen:

![](https://cdn.xhuoapi.ai/q6ytrc.png)

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, será redirigido 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 `phone`. A continuación, podemos completar el contenido correspondiente en la interfaz, como se muestra en la imagen:

<p>
  <img src="https://cdn.xhuoapi.ai/3xbffj.png" width="500" className="m-auto" />
</p>

Aquí podemos ver que hemos configurado los Request Headers, 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 ha configurado el Request Body, que incluye:

* `name`: el nombre del usuario a procesar, es un parámetro obligatorio.
* `phone`: el número de teléfono a procesar, es un parámetro obligatorio.
* `id_card`: el número de identificación del usuario a procesar, es un parámetro obligatorio.
* `verify_mode`: modo de verificación (versión larga/corta).
* `encrypt_list`/`ciphertext_blob`/`iv`: parámetros de cifrado opcionales, cifre los campos sensibles según sea necesario.

Después de seleccionar, se puede observar que también se ha generado el código correspondiente a la derecha, como se muestra en la imagen:

<p>
  <img src="https://cdn.xhuoapi.ai/0cp9z1.png" width="500" className="m-auto" />
</p>

Haga clic en el botón "Try" para realizar la prueba, como se muestra en la imagen anterior, aquí hemos obtenido el siguiente resultado:

```json theme={null}
{
  "result": "0",
  "description": "Autenticación aprobada",
  "isp": "Móvil",
  "result_detail": null
}
```

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: Resultado de verificación consistente
    * 1: Resultado de verificación inconsistente
  * Códigos de resultado sin cobro:
    * -1: Sin registros encontrados
    * -2: Error desconocido del motor
    * -3: Servicio del motor anómalo
    * -4: Verificación de nombre no aprobada
    * -5: Número de teléfono no válido
    * -6: Número de intentos de autenticación excede 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, nombre y número de identificación 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:

```shell theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/identity/phone/check-3e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "name": "***",
  "phone": "***",
  "id_card": "***"
}'
```

El código de integración en Python es el siguiente:

```python theme={null}
import requests

url = "https://api.xhuoapi.ai/v1/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)
```

## Manejo de Errores

Al llamar a la API, si se encuentra con 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 excedido el límite de tasa.
* `500 api_error`: Error interno del servidor, algo salió mal en el servidor.

### Ejemplo de Respuesta de Error

```json theme={null}
{
  "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 los tres elementos del número de teléfono para verificar la autenticidad y consistencia del número de teléfono, nombre y número de identificación. Esperamos que este documento le ayude a integrar y utilizar mejor la API. Si tiene alguna pregunta, no dude en ponerse en contacto con nuestro equipo de soporte técnico.
