Chaves de API
Crie, proteja, restrinja, rotacione e revogue credenciais de integração pelo Dashboard.
A área Integração, Chaves de API administra as credenciais usadas para conectar o sistema da sua empresa à Raims. Chaves de Sandbox e de produção pertencem a ambientes distintos e não devem ser reutilizadas entre eles.
Mantenha a chave em segredo
Nunca coloque uma chave Raims no navegador, em aplicativos distribuídos, repositórios, screenshots ou logs. Guarde a credencial na parte privada do sistema responsável pela integração.
Criar uma chave
Abra Chaves de API
Confirme o ambiente selecionado antes de criar. Contas ainda sem acesso à produção podem gerar somente chaves de Sandbox.
Dê um nome operacional
Use um nome que identifique o sistema e o ambiente, como ERP - Sandbox ou Integração principal - Produção.
Restrinja a origem quando possível
Se o sistema usa endereços de saída fixos, autorize somente esses endereços IPv4 ou intervalos CIDR.
Copie e armazene imediatamente
O segredo é exibido uma única vez na criação ou rotação. Salve-o em um cofre de segredos antes de fechar o diálogo.
Separação por ambiente
Chaves de teste usam placeholders como sk_test_... e servem para
desenvolvimento e homologação. Elas não processam dinheiro real.
A API Pública ainda não está disponível
Você já pode preparar a segurança das credenciais. Endereços, autenticação e exemplos de chamadas serão publicados na Referência da API quando a integração estiver disponível.
Armazenamento seguro
Use um gerenciador de segredos ou uma variável protegida no ambiente em que a integração é executada. Arquivos de exemplo devem conter somente o nome da variável:
RAIMS_API_KEY=sk_test_...Não versione um arquivo .env real e permita acesso somente às pessoas e aos
sistemas que precisam usar a integração.
Restrições de IP
O Dashboard aceita um endereço IPv4 individual, como 203.0.113.10, ou um
intervalo CIDR, como 203.0.113.0/24. Use somente endereços de saída estáveis e
confirmados pela sua infraestrutura.
Propriedade
Tipo
Gerenciar uma chave existente
Altera somente o rótulo operacional. Integrações existentes continuam usando o mesmo segredo.
Gera um novo segredo com as mesmas configurações e invalida o atual imediatamente. Atualize o sistema integrado assim que confirmar a rotação.
Desativa a chave permanentemente. Todos os sistemas que ainda usam o token deixam de autenticar.
Os logs ajudam a revisar as solicitações feitas com a chave, incluindo horário, endereço IP e resultado exibido no Dashboard.