Skip to main content
A API da FortalPay utiliza API keys para autenticar integrações entre servidores. Cada chave identifica o lojista, o ambiente e o nível de acesso da integração.
Nunca exponha uma API key no navegador, em aplicativos móveis, repositórios públicos ou logs. As chamadas devem partir de um backend sob seu controle.

​
Criar uma API key

No painel da FortalPay, acesse Desenvolvedores → API Keys e selecione Nova API key. Somente usuários com perfil de proprietário podem gerenciar essas credenciais. Durante a criação:
  1. Informe um nome que identifique a integração.
  2. Escolha o nível de acesso necessário.
  3. Defina uma expiração, se aplicável.
  4. Copie e armazene a chave completa em um gerenciador de segredos.
A chave completa é exibida somente uma vez, imediatamente após a criação. Depois disso, não é possível recuperá-la pelo painel.

​
Enviar a credencial

Inclua a chave completa no cabeçalho Authorization, precedida pelo esquema ApiKey e um espaço:
Não utilize Bearer. O formato Authorization: Bearer <api_key> não autentica uma API key da FortalPay.

​
Exemplo

​
Ambientes

O prefixo identifica o ambiente ao qual a chave pertence: Uma chave de teste não acessa recursos de produção, e uma chave de produção não acessa recursos de teste.

​
Níveis de acesso

Use READ_ONLY quando a integração não precisar modificar dados. Aplique sempre o menor nível de acesso necessário.

​
Respostas de autenticação

​
Armazenamento e rotação

  • Armazene a chave em variáveis de ambiente ou em um gerenciador de segredos.
  • Não inclua a chave diretamente no código-fonte.
  • Use chaves diferentes para cada aplicação e ambiente.
  • Para fazer uma rotação, crie uma nova chave, atualize a integração e somente depois revogue a anterior.
  • Revogue imediatamente uma chave que possa ter sido exposta.

Faça sua primeira requisição

Teste a autenticação consultando os produtos disponíveis.