Pular para o conteúdo principal

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

Abra 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.

Nesta página

No site

  1. Abra sua empresa

    No celular, abra primeiro o menu pelo botão de menu.

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

  2. Abra a API pública

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

    A aba Chaves de API aparece.

    Criar chave de API disponível na lista de chaves
  3. Inicie uma chave

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

    Nome vazio e produção selecionada ao criar uma chave de API
  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.

    Nome preenchido e produção selecionada ao criar uma chave de API
  5. Defina a validade

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

    Opções de expiração abertas ao criar uma chave de API
  6. Escolha as permissões

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

    Permissão de leitura de funcionários ativada na chave de API
  7. Crie a chave

    Selecione Criar chave. A chave completa aparece para você copiar.

  8. Copie e guarde a chave

    Selecione Copiar, guarde a chave em um 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 estar habilitada.
  • 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 Rotacionar para gerar outra com as mesmas permissões ou crie uma nova. A anterior deixa de funcionar na hora, então 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 seu status. A integração a envia no cabeçalho Authorization: Bearer. Consulte a referência técnica em docs.kinmu.app.

Este artigo foi útil?
Mais guias sobre conta, ia e integrações →

Não encontrou? Fale com a gente