Ambiente de desenvolvimento — dados de demonstração

Criar uma chave de API para ligar outro sistema

Crie uma chave secreta ou restrita na área Programadores, limite-a às permissões e endereços de que a integração precisa, e rode-a ou revogue-a sem parar o serviço.

Actualizado em

Uma chave de API deixa um sistema da empresa, como a contabilidade ou um portal próprio, ler e alterar dados sem uma pessoa com sessão iniciada. A área Programadores só está disponível para os perfis Proprietário e Administrador.

Antes de começar#

  • Decida o que a integração vai fazer, para escolher só as permissões necessárias. Uma chave restrita nunca recebe permissões que o seu próprio perfil não tem.
  • Para experimentar sem tocar em dados reais, entre primeiro no espaço de testes: as chaves de teste só se criam e só funcionam lá, e as chaves reais só funcionam fora dele.
  • Se o sistema que vai usar a chave tiver endereços IP fixos, tenha-os à mão.

Passo 1: Abrir as chaves#

  1. Na barra fina ao fundo do painel (visível em ecrãs largos), carregue em Programadores.
  2. Abra o separador Chaves de API.

Passo 2: Criar a chave#

  1. Carregue em Nova chave.
  2. Em Nome, escreva para que serve a chave, por exemplo "Sistema de contabilidade".
  3. Em Endereços permitidos, pode indicar endereços IP ou intervalos CIDR separados por vírgulas. Se o deixar vazio, a chave funciona a partir de qualquer endereço.
  4. Em Tipo, escolha Secreta: as suas permissões para uma chave com as permissões de quem a cria, ou Restrita: à sua escolha para escolher cada permissão.
  5. Em Modo, escolha Real ou Teste.
  6. Numa chave restrita, use Filtrar permissões para encontrar e marcar as permissões, agrupadas por área.
  7. Carregue em Criar chave.

Passo 3: Guardar o segredo#

  1. Copie a chave mostrada em Chave criada e guarde-a no gestor de segredos do sistema que a vai usar.
  2. Feche a janela. A chave completa não volta a ser mostrada: a lista só apresenta o início e os quatro últimos caracteres.

O que acontece a seguir#

  • A chave aparece na lista com o estado Activo, o Tipo, o Modo e o número de permissões.
  • Abra a linha para ver o detalhe: permissões, Endereços permitidos, Última utilização, Último endereço e um exemplo cURL para testar a chave.
  • Cada pedido feito com a chave fica em Registos e actualiza a Última utilização.
  • Para trocar o segredo, abra a chave e carregue em Rodar. Escolha a Sobreposição (Termina de imediato, 1 hora, 24 horas ou 7 dias) durante a qual a chave antiga continua a funcionar, e carregue em Rodar chave.
  • Se a chave for exposta, carregue em Revogar e confirme. Passa a Revogado e os pedidos que a usem são recusados de imediato.

Problemas comuns#

  • Aparece Escolha pelo menos uma permissão.: uma chave restrita precisa de pelo menos uma permissão marcada.
  • Aparece As chaves de teste criam-se no espaço de testes. ou No espaço de testes só se criam chaves de teste.: o modo escolhido não corresponde ao sítio onde está. Mude de espaço ou de Modo.
  • Aparece Uma chave de teste não pode ter permissões que movimentam dinheiro.: esta instalação não deixa chaves de teste criar pagamentos nem outros movimentos de dinheiro. Desmarque essas permissões de escrita na chave de teste.
  • Aparece Indique endereços IP ou intervalos CIDR válidos, por exemplo 203.0.113.0/24.: há um valor em Endereços permitidos que não é um endereço nem um intervalo. Corrija-o ou apague-o.

Artigos relacionados#

Comece hoje. Configure a sua empresa em minutos.