Saltar para o conteúdo principal

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.

Este documento apresentará uma descrição da integração da API de consulta de informações básicas do cartão bancário, que pode ser utilizada para consultar informações básicas do cartão bancário.

​
Processo de Solicitação

Para usar a API, você precisa primeiro acessar a página correspondente da API de Consulta de Informações Básicas do Cartão Bancário 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 do cartão bancário para obter o resultado de validação processado. Primeiro, você precisa passar um campo bank_card, e em seguida, podemos preencher o conteúdo correspondente na interface, conforme mostrado na imagem:

Podemos ver que aqui configuramos os Headers da Requisição, incluindo:
  • accept: o formato de resposta que você deseja receber, 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 Requisição, incluindo:
  • bank_card: número do cartão bancário.
  • encryption: opcional, parâmetro de criptografia de campo sensível (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: 
{
  "result": "0",
  "description": "Consulta bem-sucedida",
  "account_bank": "Banco Industrial e Comercial da China",
  "account_type": 1
}
O resultado retornado possui vários campos, descritos a seguir:
  • result, código de resultado da autenticação, a situação de cobrança é a seguinte.
    • Códigos de resultado de cobrança:
      • 0: Consulta bem-sucedida
      • -1: Nenhuma informação encontrada
    • Códigos de resultado sem cobrança:
      • -2: Serviço do centro de validação ocupado
      • -3: Cartão bancário inexistente
  • description, descrição do resultado do serviço.
  • account_bank, banco onde a conta foi aberta.
  • account_type, natureza do cartão: 1. Cartão de débito; 2. Cartão de crédito; 3. Cartão pré-pago; 4. Cartão de crédito condicional.
Pode-se ver que as informações básicas do cartão bancário 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: 
curl -X POST 'https://api.xhuoapi.ai/v1/identity/bankcard/check-1e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "bank_card": "****"
}'
O código de integração em Python é o seguinte: 
import requests

url = "https://api.xhuoapi.ai/v1/identity/bankcard/check-1e"

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

payload = {
    "bank_card": "****"
}

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

{
  "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 Consulta de Informações Básicas do Cartão Bancário para consultar informações básicas do cartão bancário inserido. Esperamos que este documento possa ajudá-lo a integrar e usar melhor a API. Se tiver alguma dúvida, entre em contato com nossa equipe de suporte técnico.