Chaves de API
Crie, proteja e gerencie as 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.
Consultar exige Chaves de API. Criação, rotação, alteração do nome, revogação e gestão de IPs têm permissões próprias. As ações também podem ser bloqueadas quando a conta estiver em modo de consulta. Use essas credenciais para autenticar as requisições à API da Raims.
Consultar os logs exige também Ver logs de solicitações. Esse acesso permite ler os detalhes e os corpos de solicitações e respostas disponíveis no histórico. Ter acesso às chaves não libera os logs automaticamente. Confira como conceder essa permissão à equipe.
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
Acesse Integração, Chaves de API, Criar nova chave de API com Criar 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
Preencha Nome da chave e confira Tipo da chave. 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
Selecione Criar. 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 Referência da API apresenta a autenticação, os campos e os exemplos de cada requisição. O console aceita chaves de Sandbox para testar a integração.
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.
Informe os quatro números decimais do IPv4, separados por pontos, sem zeros à
esquerda. Cada número deve estar entre 0 e 255. Para um intervalo CIDR,
acrescente / e um prefixo inteiro de 0 a 32, sem sinal ou zeros à esquerda.
O intervalo inclui toda a rede indicada pelo prefixo. Por exemplo,
203.0.113.7/24 aparece como 203.0.113.0/24 e abrange de 203.0.113.0 até
203.0.113.255. O prefixo /32 aparece como um IP individual. Entradas que
representam a mesma faixa aparecem uma única vez. Confira a lista antes de
salvar, especialmente quando informar um prefixo menor, que permite uma faixa
maior de endereços.
Propriedade
Tipo
Renomear uma chave
- Acesse Integração, Chaves de API e abra as ações da chave desejada.
- Selecione Renomear chave, informe o novo nome e confirme Renomear chave.
- Aguarde a confirmação e confira o nome na lista.
A ação exige Editar chaves de API. Ela altera somente o nome exibido; integrações existentes continuam usando o mesmo segredo.
Rotacionar uma chave
- Acesse Integração, Chaves de API e abra as ações da chave correta.
- Selecione Alterar token da chave, confira o aviso e confirme Alterar token.
- Copie e armazene o novo segredo antes de fechar o diálogo.
- Atualize os sistemas que utilizavam o token anterior.
A ação exige Rotacionar chaves de API. A rotação substitui o segredo anterior; a chave mantém as configurações apresentadas.
Gerenciar restrições de IP
- Acesse Integração, Chaves de API e abra as ações da chave.
- Selecione Gerenciar restrições de IP.
- Adicione, ajuste ou remova somente os endereços IPv4 e intervalos CIDR usados pelo seu sistema. Confira a confirmação de cada alteração.
- Use Baixar lista se precisar guardar a lista de endereços configurados.
A alteração exige Gerenciar IPs de API. Consulte Restrições de IP neste guia antes de definir uma faixa de rede. Uma lista vazia deixa a chave sem restrição por origem.
Revogar uma chave
- Acesse Integração, Chaves de API e abra as ações da chave que deseja desativar.
- Selecione Revogar chave de API, confira o token identificado e confirme Revogar chave.
- Aguarde Chave revogada.
A ação exige Excluir chaves de API e revoga a chave. Sistemas que ainda dependam desse token precisam ser atualizados com outra credencial válida.