O que a API da Biblioteca de Conhecimento é capaz de fazer

Saiba como a API da Biblioteca de Conhecimento pode ajudar você a alcançar mais funcionários onde quer que eles estejam.

Ainda não aprendeu o básico sobre a Biblioteca de Conhecimento do Workplace? Leia primeiro o guia Como criar a sua Biblioteca de Conhecimento do Workplace ou o caminho de aprendizado Ajude as pessoas a saberem todas as coisas na Workplace Academy.


As APIs da Biblioteca de Conhecimento do Workplace servem para ajudar você a fazer a migração de conteúdo e a sincronizar entre várias ferramentas de conhecimento. Ainda não sabe qual relacionamento você deseja que a sua Biblioteca de Conhecimento no Workplace tenha com ferramentas existentes, como a sua intranet, Sharepoint ou wiki? Leia esta seção do guia Cinco maneiras incríveis de usar a Biblioteca de Conhecimento. Caso ainda não conheça as APIs do Workplace em geral, visite a documentação do desenvolvedor para mais informações.

Para que servem as APIs

Para que servem as APIs

As APIs da Biblioteca de Conhecimento podem ser usadas de várias maneiras. Estas são as mais importantes:

  • Migrar conteúdo de outro sistema para a Biblioteca de Conhecimento
  • Sincronizar conteúdo entre a Biblioteca de Conhecimento e outro sistema
  • Compartilhar as análises da Biblioteca de Conhecimento com outra ferramenta
  • Buscar conteúdo questionável

Migrar conteúdo de outro sistema para a Biblioteca de Conhecimento

Migrar conteúdo de outro sistema para a Biblioteca de Conhecimento

Refere-se a integrações feitas para migrar conteúdo de outro sistema para a Biblioteca de Conhecimento. Normalmente, é usada por organizações que desejam substituir um sistema antigo, como uma intranet, uma wiki ou outro repositório, pela Biblioteca de Conhecimento. Também pode ser usada para fazer a migração estratégica de alguns conteúdos de outra ferramenta para a Biblioteca de Conhecimento por ela ser mais acessível. Além disso, as organizações a usam ocasionalmente para arquivar o conteúdo da Biblioteca de Conhecimento como parte das políticas existentes de retenção de dados.

Sincronizar conteúdo entre a Biblioteca de Conhecimento e outro sistema

Sincronizar conteúdo entre a Biblioteca de Conhecimento e outro sistema

As APIs podem ser usadas para migrações únicas. No entanto, também servem para sincronizar conteúdo regularmente entre a Biblioteca de Conhecimento e outro sistema, como uma intranet, wiki ou outro repositório de conteúdo. Isso permite retirar o conteúdo de uma intranet inadequada para dispositivos móveis, por exemplo, e transferi-lo regularmente para a Biblioteca de Conhecimento. Você também pode criar boletins informativos mensais para os funcionários na Biblioteca de Conhecimento e disponibilizá-los em outros locais na sua organização. Dessa forma, não é preciso editar o mesmo conteúdo em dois locais diferentes sempre que precisar fazer uma alteração.

Compartilhar as análises da Biblioteca de Conhecimento com outra ferramenta

Compartilhar as análises da Biblioteca de Conhecimento com outra ferramenta

Se você usa uma ferramenta centralizada para analisar o desempenho do seu conteúdo de conhecimento em vários sistemas, pode utilizar as APIs da Biblioteca de Conhecimento para obter as seguintes informações:

  • Uma lista de funcionários que visualizaram uma categoria ou subcategoria
  • Uma lista de funcionários que reagiram a uma categoria ou subcategoria específica
  • Os comentários deixados em uma categoria ou subcategoria

Cada um desses itens também possui um campo resumo para a contagem total e permite filtrar os dados por período usando os campos desde e até.

Garantir a conformidade com as políticas de conteúdo

Garantir a conformidade com as políticas de conteúdo

Isso costuma ser feito com Webhooks. No entanto, as organizações podem usar as APIs para garantir que o conteúdo da Biblioteca de Conhecimento (ou que está sendo migrado de outra ferramenta) cumpra as políticas de conteúdo existentes. Com as permissões certas, a sua integração pode ler o campo conteúdo de uma categoria e pesquisar palavras ou tipos de conteúdo específicos (como números de seguridade social). Ela também pode usar a borda /comments para buscar os comentários feitos em uma página de categoria ou subcategoria.

Noções básicas da API da Biblioteca de Conhecimento

Noções básicas da API da Biblioteca de Conhecimento

As APIs da Biblioteca de Conhecimento fazem parte dos objetos /community e /category da Graph API para o Workplace. Você usará a borda knowledge_library_categories do objeto Community para criar novas categorias ou links rápidos. Também usará o objeto Category para todo o resto.

Há dois conjuntos de permissões de API da Biblioteca de Conhecimento regendo a sua integração: Ler o conteúdo da Biblioteca de Conhecimento e Gerenciar o conteúdo da Biblioteca de Conhecimento.

A permissão Ler permite que a sua integração faça várias coisas, incluindo:

  • Obter uma lista das categorias atuais da Biblioteca de Conhecimento
  • Obter conteúdo de uma categoria (ou subcategoria) específica
  • Obter informações adicionais sobre uma categoria ou subcategoria específica, como público, visualizadores, pessoas que comentaram e autores.
  • Obter uma lista dos links rápidos da página inicial da Biblioteca de Conhecimento

Enquanto isso, com a permissão Gerenciar, a sua integração pode:

  • Criar, atualizar ou excluir uma categoria ou subcategoria
  • Definir o público, o título e o ícone de uma categoria
  • Carregar fotos, vídeos ou arquivos em uma categoria ou subcategoria
  • Criar, atualizar ou excluir um link rápido

Você usará PUBLICAR para a criação de conteúdo e para editar/atualizar qualquer parte da sua Biblioteca de Conhecimento. EXCLUIR será usado para excluir categorias, subcategorias ou links rápidos.

O que vem depois

Se não sabe para o que vai usar a sua Biblioteca de Conhecimento ou se algum dos usos acima para a API for relevante para você, leia o guia Cinco maneiras incríveis de usar a Biblioteca de Conhecimento.

Caso ainda não conheça as APIs do Workplace em geral, visite a nossa documentação do desenvolvedor.

Para saber mais sobre a nossa Biblioteca de Conhecimento em geral, explore a Central de recursos da Biblioteca de Conhecimento.