Chaves de API

Crie, revise e revogue as chaves de API da sua organização.

Uma chave de API permite que outro sistema inicie seus fluxos de trabalho pela API de Parceiros — ninguém precisa abrir o Morphic para que uma execução aconteça. A Chaves de API aba fica visível apenas para administradores.

Vá direto para: studio.morphic.com/settings/api-keys

Uma chave pertence à organização

Não à pessoa que a criou. Ela continua funcionando quando essa pessoa sai, todo administrador a vê listada e pode revogá-la, e cada execução que ela inicia é cobrada da organização.

Criar uma chave

Abra a aba

Abra o menu suspenso da organização (o logotipo do Morphic, no canto superior esquerdo), selecione Configurações e, então, clique Chaves de API na barra lateral esquerda.

Clique em Nova chave

Dê a ela um nome que você reconhecerá daqui a um mês — o sistema em que ela está, não "chave 2".

Escolha seus escopos

Três são oferecidos, e o formulário começa com os três selecionados porque uma integração de parceiro geralmente precisa dos três. Desmarque o que a chave não deve poder fazer.

  • workflows:read — ler um fluxo de trabalho e as entradas que ele recebe
  • runs:write — iniciar execuções e registrar endpoints de webhook
  • runs:read — ler o status de uma execução e seus ativos concluídos, e listar endpoints de webhook

Limite-a a fluxos de trabalho específicos

Opcional, e vale a pena fazer. Marque Limitar esta chave a fluxos de trabalho específicos e escolha-os. A execução de qualquer outra coisa é recusada, o que limita o dano se a chave vazar. Se não for marcado, a chave pode executar qualquer fluxo de trabalho que a organização puder.

Defina seus limites de crédito

O total é obrigatório — uma chave precisa ter um teto que nunca poderá ultrapassar. Limites diários e mensais são opcionais; deixe um em branco para deixar essa janela sem limite.

Escolha o total com base no que a integração deve poder gastar antes que alguém a revise novamente, não no que ela vai gastar — trata-se de um disjuntor, não de um orçamento. Um limite de janela não pode ser maior que o total, porque o total entraria em vigor antes.

Os créditos de uma execução iniciada com a chave são cobrados da organização e contabilizados nos limites dessa chave. Uma execução iniciada pela chave continua sendo contabilizada contra ela mesmo que alguém entre no chat depois e assuma o controle — caso contrário, um colega respondendo a uma pergunta moveria o restante da execução para o pool geral da organização. O próprio limite de crédito dessa pessoa, se ela tiver um, também continua valendo.

Um dia é um dia UTC e um mês é um mês civil UTC. Uma cobrança que levaria a chave além de qualquer um de seus limites é recusada, e a mensagem informa a chave e o limite atingido.

Escolha uma expiração

Nunca, 30 dias, 90 dias ou um ano. Uma chave expirada deixa de autenticar sozinha, o que é a forma mais barata de rotação.

Copiar o segredo

O segredo é mostrado uma vez. O Morphic mantém apenas um hash dele, então ele não pode ser mostrado novamente. Copie-o para o seu gerenciador de segredos antes de fechar a caixa de diálogo.

Quem tiver a chave pode iniciar execuções que gastam os créditos da sua organização. Nunca a comite, nunca a coloque em um navegador, nunca a envie por e-mail ou chat. Se ela vazar, revogue-a — é para isso que serve a aba.

O que a lista mostra

Cada chave mostra seu nome, se é uma chave de produção ou de teste, os caracteres iniciais do seu segredo (o suficiente para conferir com seus próprios registros), seus escopos, quantos fluxos de trabalho ela pode executar, seus limites de crédito e quando foi usada pela última vez. Chaves expiradas e revogadas permanecem na lista para que você possa ver o que aconteceu com elas.

Uma organização pode ter até 10 chaves que podem autenticar ao mesmo tempo. Chaves expiradas e revogadas não contam para esse limite.

Altere os limites de crédito de uma chave

  1. Encontre a chave na lista.
  2. Clique no menu '…' ao lado dela e selecione Editar limites.
  3. Altere o total, ou um limite diário ou mensal — apague um limite para removê-lo — e salve.

Os novos limites entram em vigor a partir da próxima cobrança da chave, inclusive em execuções que ela já tenha iniciado. Isso faz dessa a solução quando uma execução para no limite da chave, e isso também funciona em uma chave revogada: suas execuções ainda consomem dela, então reduzir seus limites é a forma de interrompê-las.

Revogar uma chave

  1. Encontre a chave na lista.
  2. Clique no menu '…' ao lado dela e selecione Revogar chave.
  3. Confirme.

As chamadas que a utilizam começam a falhar em segundos. Execuções já em andamento são concluídas e ainda são cobradas. Revogar não pode ser desfeito — para fazer a rotação, crie primeiro a substituta, mova seu tráfego para ela e, então, revogue a antiga.

Onde o gasto aparece

Os créditos de uma execução iniciada pela API são cobrados da organização e atribuídos à chave que a iniciou. Veja-os em Cobrança e uso → Atividade de crédito.

Nesta página