情報ライブラリAPIでできること

情報ライブラリAPIを使って、複数のツール間でリソースを同期および移行する方法を説明します。

Workplace情報ライブラリAPIは、主にコンテンツの移行と複数の情報ツール間の同期を支援することを目的としています。Workplaceの情報ライブラリと、イントラネット、SharePoint、Wikiなどの既存のツールをどのように関連付けたらよいかまだわからない場合は、「情報ライブラリの5つの優れた活用方法」の該当セクションをお読みください。また、Workplace API全般に慣れていない方は、開発者向けドキュメントにアクセスして詳細を確認してください。
このAPIの用途

このAPIの用途

情報ライブラリAPIは、さまざまな目的で利用できますが、最も重要な用途は次のとおりです。
  • 他のシステムから情報ライブラリにコンテンツを移行する
  • 情報ライブラリと他のシステムとの間でコンテンツを同期する
  • 情報ライブラリの分析結果を他のツールと共有する
  • 不適切なコンテンツをスキャンする
他のシステムから情報ライブラリにコンテンツを移行する

他のシステムから情報ライブラリにコンテンツを移行する

この用途の目的は、他のシステムと情報ライブラリを統合してコンテンツを移行することです。一般的には、イントラネット、Wiki、その他のリポジトリなどの古いシステムを情報ライブラリに置き換えようとしている組織が利用します。また、アクセシビリティを高めるために、他のツールのコンテンツの一部を情報ライブラリに戦略的に移行するという使い方もあります。組織のデータ保持ポリシーの一環として、情報ライブラリのコンテンツをアーカイブするために使うこともあります。
情報ライブラリと他のシステムとの間でコンテンツを同期する

情報ライブラリと他のシステムとの間でコンテンツを同期する

このAPIは、1回限りの移行にも使用できますが、情報ライブラリと、イントラネット、Wiki、その他のコンテンツリポジトリといった他のシステムとの間の定期的なコンテンツの同期にも使用できます。例えば、モバイルに対応していないイントラネットのコンテンツを取得して、定期的に情報ライブラリにプッシュすることができます。また、社員向けの月刊ニュースレターを情報ライブラリで作成し、組織内のどこからでも利用できるようにすることもできます。こうすると、変更のたびに同じコンテンツを2つの異なる場所で編集する必要がなくなります。
情報ライブラリの分析結果を他のツールと共有する

情報ライブラリの分析結果を他のツールと共有する

複数のシステム上にある情報コンテンツのパフォーマンスを一元的なツールで分析している場合は、情報ライブラリAPIを活用して次の情報を取得できます。
  • カテゴリまたはサブカテゴリを閲覧した社員のリスト
  • 特定のカテゴリまたはサブカテゴリにリアクションした社員のリスト
  • カテゴリまたはサブカテゴリに寄せられたコメント
これらはそれぞれ合計数用のsummaryフィールドもサポートしており、sinceフィールドとuntilフィールドを使って期間でデータを絞り込むことができます。
コンテンツポリシーの遵守を保証する

コンテンツポリシーの遵守を保証する

情報ライブラリのコンテンツ(または他のツールから移行されたコンテンツ)が既存のコンテンツポリシーに準拠していることを確認するために、多くの場合はWebhooksを使用しますが、このAPIを使用して行うこともできます。適切なアクセス許可があれば、統合によってカテゴリのcontentフィールドが読み込まれ、特定の単語やコンテンツのタイプ(社会保障番号など)で検索できます。また、/commentsエッジを使って、カテゴリまたはサブカテゴリのページに書かれたコメントをスキャンすることもできます。
情報ライブラリAPIの基本

情報ライブラリAPIの基本

情報ライブラリAPIは、Workplace用グラフAPIの/communityオブジェクトおよび/categoryオブジェクトの一部です。新しいカテゴリやクイックリンクを作成するにはCommunityオブジェクトのknowledge_library_categoriesエッジを使用し、それ以外のものを作成するにはCategoryオブジェクトを使用します。
統合を管理する情報ライブラリAPIのアクセス許可には、情報ライブラリのコンテンツの読み取りと情報ライブラリのコンテンツの管理という2つのセットがあります。
読み取りアクセス許可が付与されている場合は、統合の際に以下のようなことができます。
  • 現在の情報ライブラリのカテゴリリストを取得する
  • 特定のカテゴリ(またはサブカテゴリ)のコンテンツを取得する
  • 対象ユーザー、閲覧者、コメント投稿者、作者など、特定のカテゴリまたはサブカテゴリに関する追加情報を取得する
  • 情報ライブラリホームページのクイックリンクのリストを取得する
一方、管理アクセス許可が付与されている場合は、統合の際に以下のようなことができます。
  • カテゴリまたはサブカテゴリを作成、更新、削除する
  • カテゴリの対象ユーザー、タイトル、アイコンを設定する
  • カテゴリまたはサブカテゴリに写真、動画、ファイルをアップロードする
  • クイックリンクを作成、更新、削除する
コンテンツの作成や情報ライブラリの一部の編集・更新にはPOSTを使用し、カテゴリ、サブカテゴリ、またはクイックリンクの削除にはDELETEを使用します。

次のステップ

情報ライブラリの用途がよくわからない場合や、上記のAPIの用途のいずれかが自社のケースに当てはまる場合は、「情報ライブラリの5つの優れた活用方法」のガイドをお読みください。
同様に、Workplace API全般にまだ慣れていない場合は、開発者向けドキュメントをご覧ください。
また、情報ライブラリ全般の詳細については、情報ライブラリリソースハブをご覧ください。