Saltar para o conteúdo principal
← Conta, IA e integrações

Como crio uma chave de API para uma integração?

Abra A minha empresa e API pública, selecione Criar chave de API, defina nome, validade e permissões e copie a chave, que só aparece uma vez.

GestorWebRequer a extensão API pública
Nesta página

Na web

  1. Abra a sua empresa

    No telemóvel, abra primeiro o menu pelo botão de menu.

    Selecione A minha empresa Abrir no Kinmu Se a sua empresa usa API pública. no menu lateral. As configurações aparecem.

  2. Abra a API pública

    Na página A minha empresa, em Extensões, abra API pública.

    O separador Chaves de API aparece.

  3. Inicie uma chave

    Selecione Criar chave de API. O formulário de criação aparece.

  4. Identifique a integração

    Preencha Nome. Se houver escolha de ambiente, selecione Produção ou Sandbox. O ambiente de teste usa uma empresa com dados sintéticos.

  5. Defina a validade

    Em Expiração, escolha um prazo ou Sem expiração. Com prazo, a chave para de funcionar automaticamente quando expirar.

  6. Escolha as permissões

    Em Âmbitos, marque somente as permissões necessárias, como Colaboradores (leitura). A seleção fica visível no formulário.

  7. Crie a chave

    Selecione Criar chave. A chave completa aparece para copiar.

  8. Copie e guarde a chave

    Selecione Copiar, guarde a chave num local seguro e selecione Concluído. Ela aparece mascarada na lista e não será exibida novamente.

Se a opção não aparecer

  • A extensão de API pública precisa de estar ativada.
  • Perfis necessários: Administrador Global, Gerente.
  • Se o limite de chaves ativas foi atingido, revogue uma antes de criar outra.
  • Selecione pelo menos uma permissão antes de criar a chave.

Perguntas frequentes

Perdi a chave. Como recupero?

Não é possível vê-la novamente. Use Rodar para gerar outra com as mesmas permissões ou crie uma nova. A anterior deixa de funcionar de imediato, por isso, atualize as integrações.

Como interrompo o acesso de uma integração?

Abra a chave e selecione Revogar. Ela para de funcionar imediatamente, e a ação não pode ser desfeita.

Resultado

A chave aparece na lista com o seu estado. A integração envia-a no cabeçalho Authorization: Bearer. Consulte a referência técnica em docs.kinmu.app.

Foi útil?
Mais guias sobre este tema conta, ia e integrações →

Não encontrou o que procura? Contacte-nos