SopagueDocs
v3

Para obter as credenciais de produção, você precisa ter um login de acesso ao site da Sopague.

Como criar as credenciais

  1. Acesse o site e entre com seu login.
  2. Clique no seu usuário para abrir o menu de opções e selecione Segurança.
  3. Na página de Segurança, serão exibidas quatro opções. Selecione a última: Credenciais de API e integração.
  4. Escolha a API para a qual deseja gerar as credenciais: Gateway ou Banking.
  5. Após selecionar a API, clique em Criar credenciais.
  6. O sistema solicitará um código de autenticação de dois fatores (2FA). Informe esse código para concluir a criação.
  7. Ao concluir, o sistema exibirá uma senha. Utilize essa senha no campo password do endpoint de autenticação correspondente à API escolhida.

As URLs de produção e homologação estão documentadas na página Ambientes. Cada ambiente possui suas próprias credenciais.

Como funciona a autenticação

  1. Faça a chamada ao endpoint de autenticação da API e do ambiente que você vai utilizar.
  2. Copie o accessToken retornado na resposta.
  3. Envie o token no header Authorization das próximas requisições:
Authorization: Bearer {accessToken}
O token tem prazo de validade. Consulte expiration na resposta e obtenha um novo token antes da expiração.

Se o accessToken já incluir Bearer , envie o valor retornado diretamente no header. Não repita o prefixo.

Autenticação por API

Consulte o endpoint correspondente à opção selecionada ao criar as credenciais: