Chaves de API

A chave de API autentica as chamadas que o servidor do seu sistema faz à Rotta Pay. No menu, abra Integrações → Chaves de API. Também dá para chegar por Configurações → Integrações → Gerenciar chaves.

O texto da chave aparece uma vez só, na hora da emissão. Guarde na hora. Para usar a chave nas chamadas, veja Chaves de API na documentação de integração.

#Quem pode mexer

Qualquer pessoa da equipe vê a lista de chaves, só com o começo de cada uma. Emitir, rotacionar e revogar chaves, e mudar a lista de IPs permitidos, é só para quem tem o cargo Proprietário ou Administrador (veja Equipe). Para os outros cargos, a tela esconde os botões e avisa quem pode fazer.

#Emitir uma chave

1. Clique em Emitir chave.
2. Em Rótulo (opcional), dê um nome para reconhecer a chave, por exemplo o sistema que vai usá-la. O rótulo aparece só no painel.
3. Marque Emitir como chave de teste se a chave for de teste. Sem essa marca, a chave é de produção.
4. Clique em Emitir chave.

#Salve a chave

A janela Salve sua chave API agora mostra a Chave, a Impressão digital e o Rótulo, com o selo Teste ou Produção.

1. Clique em Copiar e guarde a chave num lugar seguro.
2. Clique em Salvei.

A janela não fecha com Esc nem com clique fora dela, só pelo Salvei ou pelo X. Depois que ela fecha, a chave não aparece mais: fica guardada só a impressão digital. Se você perdeu a chave, rotacione ou emita outra.

#Chaves ativas

A lista Chaves ativas mostra o começo de cada chave, o selo Teste ou Produção, o rótulo e a data em Criada em. Sem nenhuma chave, aparece "Nenhuma chave emitida ainda. Emita sua primeira chave para começar a integrar."

#Rotacionar uma chave

Rotacionar revoga a chave atual na hora e emite uma nova do mesmo tipo: chave de teste continua de teste, chave de produção continua de produção.

A confirmação avisa o efeito: até você colocar a nova chave no seu servidor, as chamadas à API, inclusive cobranças e saques, são recusadas. Para seguir, clique em Rotacionar e revogar a atual. A nova chave aparece na mesma janela de salvar.

#Revogar uma chave

Revogar desliga a chave. Qualquer integração que usa essa chave perde o acesso na hora, e não dá para desfazer. Confirme em Revogar.

#IPs permitidos

O quadro IPs permitidos (API) é uma proteção a mais, além da chave. Com a lista vazia, não há restrição. Com pelo menos um IP na lista, a API só aceita chamadas desses IPs, inclusive saques.

Vale endereço IPv4, IPv6 ou faixa CIDR, como 203.0.113.10 ou 203.0.113.0/24.

Para adicionar um IP:

1. Digite o endereço em IP ou CIDR.
2. Se quiser, preencha Descrição (opcional), por exemplo o nome do servidor.
3. Clique em Adicionar.

O primeiro IP liga a trava. A tela pede confirmação em Ligar a trava, porque a partir dali chamadas de qualquer outro IP são recusadas.

Remover tira um IP da lista: cobranças e saques vindos dele passam a ser recusados na hora. Remover o último IP desliga a trava (Remover e desligar a trava), e a API volta a aceitar chamadas de qualquer IP com a chave válida.

A tela mostra Seu IP atual (deste navegador). Atenção: quem chama a API é o servidor do seu sistema, não o seu navegador. Cadastre o IP do servidor.