Autenticação

Sessão, credenciais de integração e validação de identidade operacional

View as Markdown

Modelo de autenticação

A integração utiliza duas camadas:

  • autenticação por sessão;
  • autenticação de integração.

Elas trabalham em conjunto para confirmar quem está operando, qual conta foi autorizada e se a chamada pertence à integração liberada para esse usuário.

Vínculo do usuário e do acesso

O usuário que opera a integração precisa estar vinculado corretamente na plataforma e criar um acesso específico para API.

Esse acesso deve ser:

  • do tipo INTEGRATION;
  • mantido com a permissão INTEGRATION_ONLY ativa;
  • usado no login da API PIX com email e senha próprios.

Sessão operacional

A sessão operacional é obtida no login da API PIX e é reutilizada nas rotas protegidas documentadas para customers e cobranças. Essa sessão deve permanecer coerente com a identidade operacional liberada para o usuário.

Papel da chave de integração

A credencial de integração existe para comprovar que a chamada não depende apenas de uma sessão autenticada, mas também de um conjunto de credenciais emitido especificamente para aquele integrador.

Regras importantes:

  • a credencial de integração identifica o solicitante autorizado;
  • o segredo associado à conta é exclusivo do usuário que recebeu a liberação;
  • a autenticação de integração deve representar o mesmo usuário autenticado na sessão;
  • qualquer divergência entre sessão e credencial deve ser tratada como falha de autenticação.

Solicitação das chaves

No pedido ao suporte, informe:

  • usuário responsável pela integração e o acesso criado para API;
  • ambiente;
  • origem ou domínio operacional;
  • wallet de recebimento;
  • confirmação de que essa wallet já está cadastrada e aprovada na plataforma.

Armazenamento seguro

  • nunca publique credenciais de integração em repositórios;
  • não exponha o segredo operacional em logs;
  • use cofre de segredos ou variáveis de ambiente;
  • faça rotação se houver suspeita de exposição.

Onde ver os detalhes técnicos

Todos os formatos de credencial, requisitos de envio, validações e exemplos práticos ficam concentrados na área API Reference.