Referência Técnica

Visão Geral Técnica

Estrutura prática da autenticação, dos endpoints e dos modelos de integração

View as Markdown

Esta seção concentra todo o conteúdo técnico e implementável da documentação. Os guias do projeto permanecem conceituais; os detalhes de conexão, autenticação, parâmetros, exemplos de envio e formatos de resposta ficam exclusivamente aqui.

Organização da API Reference

  • Autenticação da API: criação do acesso de integração, login, credenciais e validações;
  • API de Customers: criação, listagem, atualização e remoção lógica de customers;
  • API de Cobranças PIX: criação de cobrança, listagem com filtro por período e consulta individual;
  • Modelos de Erro: formatos de erro da plataforma e da camada PIX;
  • OpenAPI Explorer: visão estrutural gerada a partir do spec do projeto.

Bases documentadas

  • https://gmc-api.gomoney.me/api: gerenciamento de customers e demais rotas da API platform;
  • https://api-pix.gomoney.me: autenticação e gerenciamento das rotas PIX.

Acesso exigido

Antes de consumir a API, a conta precisa ter um acesso criado na plataforma com:

  • tipo INTEGRATION;
  • permissão INTEGRATION_ONLY ativa;
  • email e senha próprios para o login da API PIX.

Além disso, o suporte precisa ter liberado:

  • clientKey e clientSecret;
  • o domínio que enviará o header Origin;
  • a wallet aprovada para direcionamento dos recebimentos via PIX em GMC.

Sequência técnica recomendada

  1. Criar o acesso de integração na plataforma.
  2. Confirmar que esse acesso está com INTEGRATION_ONLY ativo.
  3. Solicitar ao suporte o clientKey, o clientSecret e a liberação do domínio.
  4. Confirmar que a wallet operacional está cadastrada e aprovada.
  5. Fazer login na API PIX com o email e a senha do acesso de integração.
  6. Montar a secret-key no formato btoa(clientKey:clientSecret).
  7. Cadastrar ou localizar o customer que será usado na conciliação.
  8. Gerar a cobrança PIX com customerIdentifier.
  9. Consultar a lista ou o detalhe da cobrança para acompanhar o ciclo operacional.

Observações de uso

  • o token obtido no login da API PIX deve sempre vir do acesso INTEGRATION_ONLY;
  • a sessão autenticada, a secret-key e o domínio autorizado devem representar a mesma integração;
  • a wallet operacional informada ao suporte precisa estar registrada e aprovada na plataforma;
  • o identificador do customer deve ser enviado nas cobranças PIX para garantir conciliação correta;
  • a collection Postman do projeto permanece inalterada e fora do escopo de edição desta documentação.