> ## 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.
# Documentação de Integração da API de Verificação de Dois Fatores de Número de Telefone
> Identity Authentication 集成指南 - XHuoAPI
Este documento apresentará uma API de verificação de dois fatores de número de telefone, que pode ser usada para verificar a autenticidade e a consistência do número de telefone e do nome.
## Processo de Solicitação
Para usar a API, você precisa primeiro acessar a página correspondente da [API de Verificação de Dois Fatores de Número de Telefone](https://api.xhuoapi.ai/documents/1f39c948-6d9b-48f5-83fb-0719da4f6ab0) para solicitar o serviço correspondente. Após entrar na página, clique no botão "Adquirir", conforme mostrado na imagem:
Se você ainda não estiver logado ou registrado, será redirecionado automaticamente para a página de login, convidando-o a se registrar e fazer login. Após o registro e login, você será redirecionado de volta para a página atual.
Na primeira solicitação, haverá um limite gratuito disponível, permitindo o uso gratuito da API.
## Uso Básico
Primeiro, entenda a forma básica de uso, que é inserir o número de telefone para obter o resultado processado. Primeiro, você precisa passar um campo `mobile`. Em seguida, podemos preencher o conteúdo correspondente na interface, conforme mostrado na imagem:
Podemos ver que aqui configuramos os Headers da Solicitação, incluindo:
* `accept`: o formato de resposta desejado, aqui preenchido como `application/json`, ou seja, formato JSON.
* `authorization`: a chave para chamar a API, que pode ser selecionada diretamente após a solicitação.
Além disso, configuramos o Corpo da Solicitação, incluindo:
* `name`: o nome do usuário a ser processado, é um parâmetro obrigatório.
* `mobile`: o número de telefone a ser processado, é um parâmetro obrigatório.
* `encryption`: opcional, parâmetro de criptografia de campos sensíveis (se precisar enviar dados criptografados).
Após a seleção, você pode notar que o código correspondente também foi gerado à direita, conforme mostrado na imagem:
Clique no botão "Tentar" para realizar o teste, como mostrado na imagem acima, e aqui obtivemos o seguinte resultado:
```json theme={null}
{
"result": "0",
"description": "Resultado da verificação consistente"
}
```
O resultado retornado contém vários campos, descritos a seguir:
* `result`, código do resultado da autenticação, com as seguintes condições de cobrança.
* Códigos de resultado cobrados:
* 0: Resultado da verificação consistente
* 1: Resultado da verificação inconsistente
* Códigos de resultado não cobrados:
* -1: Nenhum registro encontrado
* -2: Erro desconhecido do mecanismo
* -3: Anomalia no serviço do mecanismo
* -4: Verificação do nome não aprovada
* -5: Número de telefone inválido
* -6: Número de tentativas de autenticação excedeu o limite diário, por favor, tente novamente no dia seguinte
* `description`, descrição do resultado do negócio.
Pode-se ver que a autenticidade e a consistência do número de telefone e do nome já foram consultadas.
Além disso, se você quiser gerar o código de integração correspondente, pode copiá-lo diretamente, por exemplo, o código CURL é o seguinte:
```shell theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/identity/phone/check-2e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
"name": "***",
"mobile": "***"
}'
```
O código de integração em Python é o seguinte:
```python theme={null}
import requests
url = "https://api.xhuoapi.ai/v1/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)
```
## Tratamento de Erros
Ao chamar a API, se ocorrer um erro, a API retornará o código de erro e a mensagem correspondentes. Por exemplo:
* `400 token_mismatched`: Solicitação inválida, possivelmente devido a parâmetros ausentes ou inválidos.
* `400 api_not_implemented`: Solicitação inválida, possivelmente devido a parâmetros ausentes ou inválidos.
* `401 invalid_token`: Não autorizado, token de autorização inválido ou ausente.
* `429 too_many_requests`: Muitas solicitações, você excedeu o limite de taxa.
* `500 api_error`: Erro interno do servidor, algo deu errado no servidor.
### Exemplo de Resposta de Erro
```json theme={null}
{
"success": false,
"error": {
"code": "api_error",
"message": "falha na busca"
},
"trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```
## Conclusão
Através deste documento, você já entendeu como usar a API de Verificação de Dois Fatores de Número de Telefone para verificar a autenticidade e a consistência do número de telefone e do nome. Esperamos que este documento possa ajudá-lo a integrar e usar melhor essa API. Se tiver alguma dúvida, entre em contato com nossa equipe de suporte técnico.