Pular para o conteúdo principal

1. Crie sua API Key

Acesse a página de Integração no painel, clique em Criar Nova API Key, dê um nome descritivo e copie a chave gerada.
A API Key é exibida apenas uma vez. Armazene-a em local seguro.

2. Faça sua primeira requisição

Todas as requisições devem incluir o header x-api-key com sua chave:

3. Teste no ambiente de homologação

Sua organização começa no ambiente de homologação, onde você pode testar todas as funcionalidades sem processar transações reais. Use o endpoint de simular pagamento para confirmar cobranças manualmente durante os testes.

4. Ative a produção

Quando estiver pronto, envie a documentação da empresa pelo painel e aguarde a aprovação. Após ativado, gere uma nova API Key para o ambiente de produção.

Resumo para integrar

  • URL base: https://api.alphagateway.com.br. Todas as rotas começam com /v1.
  • Autenticação: header x-api-key com a API Key criada no painel, na página Integração. A mesma URL atende homologação e produção: o ambiente é o da organização dona da chave.
  • Formato: JSON em UTF-8 na requisição e na resposta. Valores em reais com até duas casas decimais (ex.: 49.90); datas em ISO 8601 (UTC).
  • Respostas: sucesso e erro seguem um formato padrão, com o status HTTP correspondente. Detalhes em Autenticação e escopos.
  • Idempotência: cobranças, boletos e saques exigem um idempotency único por organização. Repetir a chamada com o mesmo valor não cria outra operação: a API responde 400 (409 nos links de pagamento) e o resultado da primeira chamada pode ser consultado pelo mesmo idempotency.
  • Confirmações: pagamentos, saques e devoluções são assíncronos. Receba o resultado por webhook (veja Configurar webhooks) ou consulte a operação pelo idempotency.
  • Testes: no ambiente de homologação, as rotas de simular pagamento (em Referência da API) simulam o pagamento de cobranças e boletos sem dinheiro real.