Referência da API

Introdução

A documentação dos serviços da API da AQPago foi desenvolvida para ajudá-lo na integração de sua aplicação com nossos serviços bancários. Este material foi estruturado em etapas estratégicas, de acordo com a jornada de uso do cliente, desde o cadastro até operações avançadas. Nosso objetivo é garantir que sua experiência seja segura, eficiente e em total conformidade com as regulamentações financeiras.

Siga as etapas abaixo para começar:

  • Cadastro e Credenciamento
    Este é o ponto inicial para acessar os serviços de API da AQPago. Aqui, clientes realizam o cadastro com CPF ou CNPJ, enviam a documentação necessária e passam por um processo de onboarding para validação de identidade. Caso deseje integração via API, deve ser solicitado ao time comercial uma Chave de API exclusiva, que será combinada ao documento cadastrado (CPF/CNPJ) para autenticação.

  • Endpoints da API
    Oferecemos dois ambientes para que você integre sua aplicação:

    1. Homologação: usado para testar e validar os serviços da API antes de ser lançada no ambiente de produção.
    2. Produção: é o ambiente em que o sistema é usado pelos usuários finais.

  • API REST
    Nossa API foi desenvolvida seguindo os princípios de design REST, utilizando verbos HTTP e códigos de status. Todas as requisições e respostas são processadas no formato JSON.
    Acesse a página Cartões de Simulação e veja quais cartões podem ser usados para simular transações.

  • Autenticação e Autorização
    Uma vez autenticado, o cliente receberá um novo Token que deverá ser usado em todas as requisições futuras. Todas as requisições necessitam de Autenticação prévia para uma maior segurança. Sem autenticação, o cliente não poderá ter acesso aos serviços da API.

  • Integração Automática
    A AQPago oferece alternativas para quem prefere não integrar manualmente. Oferecemos módulos prontos para integrar nossa API de forma automática em plataformas como Magento e WooCommerce sem ter que programar.
    Saiba mais no tópico: Integração Automática

Pronto para começar?


Para iniciar, comece pelo tópico Cadastro e Credenciamento e, em seguida, Autenticação e Autorização, ou explore nossa Coleção do Postman com exemplos práticos.

Em caso de dúvidas, nossa equipe de suporte está disponível para auxiliá-lo em qualquer etapa do processo de integração da nossa API.

Siga os passos acima e consulte as explicações e os exemplos de código em nossa documentação completa.