Skip to main content
Este documento irá 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 de consulta de informações básicas do cartão bancário, primeiro acesse o Painel de Controle da Ace Data Cloud para obter seu Token de API, que deve ser guardado para uso futuro. Se você ainda não estiver logado ou registrado, será redirecionado automaticamente para a página de login, convidando-o a se registrar e logar; após a conclusão, você será redirecionado de volta para a página atual. Um Token de API é suficiente para acessar todos os serviços da plataforma, não sendo necessário solicitar um para cada serviço individualmente. A primeira solicitação vem com um crédito gratuito, permitindo uma experiência sem custo; quando o crédito estiver baixo, você pode recarregar o saldo geral no painel de controle.
📘 Documentação Completa: API de Consulta de Informações Básicas do Cartão Bancário →

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, como mostrado na imagem:

Podemos ver que aqui configuramos os Headers da Requisiçã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 Requisição, incluindo:
  • bank_card: número do cartão bancário.
  • encryption: opcional, parâmetro de criptografia de campos sensíveis (caso precise enviar dados criptografados).
Após a seleção, podemos notar que o código correspondente também foi gerado à direita, como mostrado na imagem:

Clique no botão “Try” para realizar o teste, como mostrado na imagem acima, e aqui obtivemos o seguinte resultado:
O resultado retornado possui vários campos, descritos a seguir:
  • result, código de resultado da autenticação, com as seguintes situações de cobrança.
    • 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.
Podemos 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:
O código de integração em Python é o seguinte:

Tratamento de Erros

Ao chamar a API, se ocorrer um erro, a API retornará o código de erro e a mensagem correspondente. 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

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 essa API. Se tiver alguma dúvida, entre em contato com nossa equipe de suporte técnico.