Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.salvy.com.br/llms.txt

Use this file to discover all available pages before exploring further.

As chaves de API permitem que seus sistemas se autentiquem com a API da Salvy. Você pode criar, listar e revogar chaves a qualquer momento na página de API & Webhooks do dashboard.

​
Acessando a página

A página de gerenciamento de chaves está disponível em Configurações > Funcionalidades > API & Webhooks, ou diretamente em app.salvy.com.br/settings/api.

​
Criando uma chave

  1. Acesse a página de API & Webhooks.
  2. Clique em Criar chave de API.
  3. Dê um nome à chave para identificá-la depois — por exemplo, o sistema ou o ambiente em que ela será usada.
  4. Clique em Criar chave.
A chave gerada é exibida apenas uma vez no momento da criação. Copie e guarde-a em um local seguro imediatamente — ela não poderá ser exibida novamente.
Após copiar a chave, use-a no cabeçalho Authorization das suas requisições: 
Authorization: Bearer <sua_chave>
Consulte a Introdução para mais detalhes sobre autenticação.

​
Revogando uma chave

Para revogar uma chave, clique no ícone de lixeira na coluna Ações e confirme a ação.
A revogação é imediata e não pode ser desfeita. Qualquer sistema que esteja utilizando a chave deixará de acessar a API assim que a revogação for confirmada.
Chaves revogadas continuam visíveis na tabela com o status Revogada, junto com a data e o usuário responsável pela revogação, para fins de auditoria.

​
Boas práticas

  • Crie uma chave separada para cada sistema ou ambiente (produção, homologação, etc.) para facilitar o rastreamento e a revogação.
  • Nunca compartilhe chaves em repositórios públicos, e-mails ou mensagens. Armazene-as em um cofre de segredos.
  • Revogue imediatamente qualquer chave que possa ter sido exposta e crie uma nova em seu lugar.
  • Utilize nomes descritivos ao criar chaves para facilitar a identificação posterior.