O recurso de Interface de programação de aplicativos (API) de relatórios da KnowBe4, limitado a clientes Platina e Diamante, permite extrair dados do console do KSAT para geração de relatórios. Atualmente, esse recurso é limitado para permitir solicitações de dados de phishing, treinamento, usuários e grupos. Para usar essa API, você precisa se autenticar na API usando uma chave específica da conta.

Para obter detalhes completos sobre a API de relatórios, bem como solicitações de amostra, acesse a documentação do Desenvolvedor da API de relatórios. A API da KnowBe4 é uma API REST. Ao usar a API da KnowBe4, você concorda com nossos Termos de uso.

Como criar um token da API de relatórios

Para criar um token da API de relatórios, siga as etapas abaixo:

1. No console do KSAT, clique no endereço de e-mail localizado no canto superior direito da página e selecione Configurações da conta.
2. Navegue até Integrações da conta > API.
3. Em API de relatórios, selecione o botão de alternância Habilitar acesso à API de relatórios.
4. Clique em API de relatórios. A subguia API de relatórios será aberta.
5. No canto superior direito da subguia API de relatórios, clique em + Criar novo token da API.
6. Preencha os campos na página Criar novo token da API. Para obter mais informações, veja a captura de tela e a lista abaixo:
   1. Nome: nesse campo, informe um nome descritivo para o token da API.
   2. Status: habilite ou desabilite o token da API.
   
7. Clique em Criar token. A janela pop-up Token da API de relatórios será aberta.
8. Clique no token da API de relatórios para copiar o token. Certifique-se de salvar o token da API copiado em um lugar de fácil acesso. Depois de fechar essa janela, você não conseguirá ver esse token novamente.
9. Clique em OK.

Depois de copiado, você poderá usar o token da API para extrair dados do console do KSAT e usá-los na geração de relatórios.

Como gerenciar tokens da API de relatórios

Após a criação de um token da API de relatórios, você poderá gerenciá-lo na subguia API de relatórios. É possível acessar essa subguia na seção Integrações da conta da página Configurações da conta.

Para saber mais sobre as opções disponíveis nessa subguia, veja abaixo:

1. Chave: essa coluna exibe um identificador exclusivo usado para autenticar uma solicitação de API associada ao console do KSAT.
2. Nome: essa coluna exibe o nome personalizado que você atribuiu ao seu token da API quando ele foi criado.
3. Gerado por: essa coluna exibe o endereço de e-mail associado ao usuário que gerou o token da API.
4. Gerado em: essa coluna exibe a data em que o token da API de relatórios foi gerado.
5. Status: essa coluna exibe o status do token da API. O status pode ser Habilitado ou Desabilitado.
6. Ações: clique na seta suspensa na coluna à extrema direita para ver as ações disponíveis para um token da API de relatórios. Essas ações incluem:
   • Editar: clique em Editar para abrir a página Editar token da API de relatórios, que é semelhante à página Criar novo token da API. Edite as opções de acordo com a necessidade e clique em Atualizar token para salvar as alterações.
   • Excluir: clique em Excluir para excluir permanentemente um token da API de relatórios.