API Kibi

A API REST Kibi permite que aplicativos externos, assistentes de IA e automações acessem os dados do Kibi Connect. Por meio da API, é possível ler e gravar conteúdos — desde páginas de wiki, passando por publicações de notícias, até tarefas e entradas de calendário.

#Ativar acesso à API

A API REST deve ser ativada primeiro por um administrador do sistema. A configuração está localizada em:

Configurações → Integrações → API REST

As seguintes opções estão disponíveis aqui:

Ativar API REST

Ativa ou desativa a interface da API.
Restringir criação de tokens a funções específicas

Quando ativado, apenas usuários com as funções selecionadas podem criar tokens de API. Usuários individuais podem ser autorizados adicionalmente por meio do acesso à função na guia Segurança de seus perfis.
Ativar restrição de IP

Quando ativado, apenas os endereços de IP especificados podem acessar a API. Isso é uma camada adicional de segurança.

Captura de tela: Configurações da API em Integrações

#Criar token de API

Cada usuário pode criar seus próprios tokens de API por meio de seu perfil de usuário. Para isso, navegue até:

Perfil do usuário → Integrações → Criar novo token

Ao criar um token, você define:

Nome

Um nome descritivo (por exemplo, "Agente de IA", "Integração ERP", "Automação de fluxo de trabalho").
Permissões (Escopos)

Selecione apenas as permissões que a integração realmente precisa (princípio do menor privilégio).
Data de expiração (opcional)

Opcionalmente, uma data de expiração pode ser definida, após a qual o token se tornará automaticamente inválido.

Captura de tela: Formulário de criação de token com escopos

#Armazenar token com segurança

Após a criação, o valor do token é exibido apenas uma vez. Copie-o imediatamente e armazene-o com segurança (por exemplo, em um gerenciador de senhas). Em caso de perda, o token deve ser revogado e um novo deve ser criado.

Captura de tela: Token após a criação — visível apenas uma vez

#Permissões disponíveis (Escopos)

Os seguintes escopos controlam o acesso do token de API a diferentes áreas:

Escopo	Descrição
`posts:read`	Ler publicações e notícias publicadas
`posts:write`	Criar, atualizar e excluir publicações
`wiki:read`	Ler páginas de wiki e documentação
`wiki:write`	Criar e atualizar páginas de wiki
`calendar:read`	Ler entradas de calendário
`calendar:write`	Criar, atualizar e excluir entradas de calendário
`groups:read`	Ler grupos públicos, membros, publicações e arquivos
`surveys:read`	Ler pesquisas e resultados
`tasks:read`	Ler tarefas (apenas as próprias ou atribuídas)
`tasks:write`	Criar e atualizar tarefas
`users:read`	Ler diretório público de usuários (sem dados privados)
`chat:read`	Ler conversas e mensagens
`chat:write`	Enviar mensagens (para bots e automações)
`notifications:read`	Ler notificações do usuário
`notifications:write`	Enviar notificações aos usuários (incluindo push)
`search`	Pesquisa transversal de entidades

#Autenticação da API

Todas as solicitações da API devem incluir o token como Bearer Token no cabeçalho Authorization:

curl -H "Authorization: Bearer kbc_SeuTokenAqui" \
     https://sua-empresa.kibi.de/api/v1/wiki

A URL base da API é: https://sua-empresa.kibi.de/api/v1

#Endpoints disponíveis

A documentação completa da API com todos os endpoints e parâmetros está disponível diretamente no Kibi Connect em:

Documentação interativa: Perfil do usuário → Integrações → Documentação da API
Especificação OpenAPI (JSON): Perfil do usuário → Integrações → OpenAPI JSON

Visão geral dos endpoints mais importantes:

Área	Endpoint	Descrição
Wiki	`GET /wiki`	Listar páginas de wiki
Wiki	`POST /wiki`	Criar página de wiki
Notícias	`GET /posts`	Listar publicações
Tarefas	`GET /tasks`	Listar tarefas
Calendário	`GET /calendar/events`	Listar entradas de calendário
Chat	`POST /chat/direct`	Enviar mensagem direta
Usuários	`GET /users`	Listar diretório de usuários
Pesquisa	`GET /search`	Pesquisa de texto completo transversal de entidades

#Gerenciar tokens

Todos os tokens criados são exibidos na visão geral em Perfil do usuário → Integrações. Aqui você vê:

O nome do token
As permissões atribuídas
Quando o token foi usado pela última vez
A opção de revogar um token

Captura de tela: Visão geral de tokens com tokens ativos

#Observações importantes

Acesso a dados: Tokens de API têm acesso apenas aos dados aos quais o respectivo usuário também tem acesso. As permissões do usuário continuam a vigorar.
Segurança: Nunca compartilhe tokens de API publicamente. Armazene tokens em variáveis de ambiente ou em um gerenciador de segredos, não no código-fonte.
Menor privilégio: Conceda apenas as permissões mínimas necessárias. Um token para uma integração de wiki não precisa de acesso ao chat.
Data de expiração: Defina uma data de expiração para integrações temporárias para aumentar a segurança.
Revogação: Revogue imediatamente tokens que não são mais necessários por meio da visão geral de tokens.