Saltar para o conteúdo principal
Toda a documentação

Criar e proteger chaves de API

Crie credenciais de produção ou sandbox com o âmbito mínimo, configure restrições de IP quando forem úteis e rode ou revogue as chaves em segurança.

Fluxo de trabalho
  1. Escolher o contextoSelecione a área pessoal ou o espaço de trabalho da organização.
  2. Definir permissõesDê um nome à chave e selecione apenas os âmbitos necessários.
  3. Limitar origensOpcionalmente, introduza os endereços IP ou redes válidos dos clientes.
  4. Guardar uma única vezGuarde o segredo apresentado num gestor de segredos protegido.
  5. Manter o acessoRode uma chave para a substituir e revogue as credenciais antigas.

Âmbitos e funções

A página Chaves de API lista as descrições dos âmbitos suportados, incluindo leitura da conta, inferência e formação de IA, trabalhos de alojamento de IA, trabalhos de transformação de modelos, serviços de blockchain e permissões para tickets de suporte. Numa organização, os proprietários e administradores gerem as chaves; os membros podem consultá-las, mas não geri-las. Selecione o contexto ao qual a credencial deve pertencer, pois a visibilidade e a autoridade dependem do contexto.

  1. Selecione a organização pretendida antes de abrir Chaves de API.
  2. Leia as descrições dos âmbitos e escolha apenas as operações necessárias.
  3. Se não puder gerir as chaves, peça ajuda a um proprietário ou administrador.

Criar uma chave de produção

Uma chave normal exige um nome entre 2 e 120 caracteres, pelo menos um dos âmbitos listados e, opcionalmente, uma lista de IP autorizados. Introduza endereços IP ou redes CIDR válidos, um por linha, respeitando o limite apresentado. Uma lista vazia permite qualquer IP de origem. O valor completo em texto simples só é apresentado uma vez após a criação; apenas o hash é guardado e o segredo não pode ser recuperado mais tarde.

  1. Use um nome que identifique a aplicação ou o ambiente.
  2. Escolha os âmbitos mínimos e as origens estáveis necessárias.
  3. Guarde o valor apresentado diretamente no armazenamento de segredos aprovado.

Chave de inferência sandbox

O painel permite criar uma chave sandbox limitada à inferência de IA e à franquia mensal de pedidos aí apresentada. Só pode existir uma chave sandbox ativa por conta ou contexto de organização. Se já existir uma, utilize-a ou revogue-a antes de a substituir. Mantenha as credenciais sandbox e de produção separadas e não trate a franquia sandbox como garantia de serviço de produção.

  1. Verifique se já existe uma chave sandbox ativa neste contexto.
  2. Crie uma chave para testes de inferência e guarde-a separadamente.
  3. Acompanhe a franquia e revogue a chave quando deixar de ser necessária.

Proteger o segredo

Copie a chave completa apenas quando a criação ou rotação a apresentar. Guarde-a num gestor de segredos cifrado, com acesso limitado ao serviço que a utiliza. Nunca a inclua em código-fonte, código do browser, registos, capturas de ecrã, tickets ou mensagens. Se não guardou o valor apresentado uma única vez ou não o encontrar, rode a chave; o suporte não consegue recuperar o texto simples.

  1. Transfira o valor apresentado diretamente para o armazenamento protegido.
  2. Configure o consumidor de acordo com as instruções próprias da aplicação.
  3. Rode a chave imediatamente se suspeitar de exposição ou perda.

Rodar ou revogar

A rotação revoga a credencial antiga e cria uma substituta com o mesmo nome, nível, âmbitos e lista de IP autorizados. O novo valor é apresentado uma única vez; atualize rapidamente os serviços dependentes, pois a chave antiga deixa de funcionar. A revogação desativa a chave selecionada sem a substituir. Confirme o contexto e a chave corretos antes de executar qualquer uma das ações.

  1. Identifique todos os serviços consumidores antes de uma rotação planeada.
  2. Guarde o novo valor e atualize os serviços dependentes.
  3. Revogue as chaves antigas e confirme o estado no painel.

Diagnosticar pedidos rejeitados

Um pedido pode ser rejeitado se a chave estiver malformada ou revogada, se o utilizador estiver inativo, se o IP de origem não estiver na lista autorizada ou se faltar o âmbito pedido. Os pedidos sandbox também podem exceder o limite mensal. Confirme o contexto, a versão do segredo implementada, o endereço de saída do cliente e o âmbito necessário. Nunca forneça o segredo ao pedir ajuda.

  1. Confirme que a chave está ativa e inclui o âmbito da operação.
  2. Compare o IP de origem real e a franquia sandbox.
  3. Rode a chave se estiver errada ou exposta; partilhe apenas referências sem segredos.

Perguntas frequentes

Posso recuperar uma chave mais tarde?

Não. Rode-a para criar um novo valor de substituição.

Que âmbitos devo conceder?

Apenas os âmbitos listados necessários para a integração.

Os membros podem criar chaves da organização?

Não. Só os proprietários e administradores gerem as chaves da organização.

A rotação mantém a chave antiga ativa?

Não. Revoga-a e cria uma chave de substituição.

E se o IP do cliente mudar?

Um gestor de chaves autorizado deve atualizar a lista de IP permitidos.

Posso ter duas chaves sandbox?

Só pode existir uma chave sandbox ativa por contexto.

Páginas relacionadas