Teachme Bizで提供しているAPIについて教えてください – ヘルプセンター | Teachme Biz

システム連携に必要な詳細仕様については、以下のドキュメントをご確認ください。
https://docs.api.teachme.jp

※ドキュメントは日本語で作成しています。
必要に応じ、お手元で翻訳してご利用ください。

概要

API連携とは、外部システムやアプリケーションからマニュアル情報を呼び出すための仕組みです。
APIを利用することで、Teachme Biz上からだけでなく外部システムからマニュアル情報を利用することが可能になります。

対応プラン

本機能をご利用可能なプラン・オプションに関してはリンク先をご確認ください。

詳細

APIで取得できるのは、公開中のマニュアルの文字の情報です。
APIでマニュアルを作成・編集・削除することはできません。

マニュアル一覧API

登録されているマニュアルのリストを取得できます。
1回の呼び出しで取得できるのは最大100件です。
続きは次のページとして呼び出すことで、すべてのマニュアルを取得できます。
キーワードを指定した場合は、関連するマニュアルを関連度の高い順に最大100件取得します（次のページはありません）。
マニュアルごとに取得できるのは、マニュアルID・URL・タイトル・表紙の説明文・マニュアルが入っているフォルダです。

マニュアル詳細API

マニュアルごとに、詳細情報を取得できます。
一覧APIで取得できる情報に加えて、ステップの内容と、表紙・ステップのカスタム項目を取得できます。
自動翻訳機能をご利用のグループでは、言語を指定して翻訳した内容を取得することもできます。

取得できる情報

マニュアルID、マニュアルのURL
タイトル、表紙の説明文
ステップタイトル、ステップの説明文（マニュアル詳細APIのみ）
表紙とステップのカスタム項目の項目名と入力内容（マニュアル詳細APIのみ）
マニュアルが入っているフォルダの名前と階層

取得できない情報

表紙とステップの画像・動画
画像や動画に付けたマーキング、動画の字幕
表紙の関連マニュアル・外部リンク・位置情報
下書き状態のマニュアル
閲覧数・作成者・更新日時など、マニュアルの管理に関する情報
ユーザーやトレーニングなど、マニュアル以外の情報

よくある質問

Q. どのような外部ツールと連携できますか？

A. APIを呼び出し、受け取ることが可能なシステムであれば、理論上、自社開発のシステムや市販のチャットボット、生成AIツールなど幅広く連携が可能です。

Q.APIで取得できる情報に制限はありますか？

A.はい。
取得できる情報は、APIキーを発行したユーザーが閲覧できる範囲に準じます。
APIキーを発行したユーザーが閲覧できないマニュアルを取得することはできません。

Q: 発行したAPIキーや連携設定に有効期限は設定できますか？

A.有効期限の設定は複数段階可能で、無期限を設定することもできます。
ただし注意点として、APIキーを発行したユーザーがグループから削除されると連携が停止します。
意図しないAPI連携の停止を防ぐために、APIキー発行用のユーザーを作成していただくことをおすすめします。

Q.複数のAPIキーを自社のシステムに設定できますか？

A.はい。
例えば、部署別にマニュアルの検索範囲が定められたAPIキーを発行し、各システムに連携させることも可能です。

Q.IPアドレス制限下で、許可外のネットワークからAPIを用いてマニュアル検索を行うことはできますか？

A.はい。
APIはIPアドレス制限の影響を受けません。

Q. APIでマニュアルの情報を取得した場合、対象のマニュアルの閲覧数にカウントされますか？

A. いいえ。
APIによるマニュアル検索及び情報取得は、マニュアルの閲覧数にカウントされません。

Q. 導入にあたって技術的なサポートは受けられますか？

A. システムとの連携については、お客様側でご対応いただく必要がございます。

Q. MCP（Model Context Protocol）に対応していますか？

A. いいえ、対応しておりません。
ユーザー様側にてご利用のシステムや生成AIでAPIの呼び出しを行うプログラムを構築・実装していただくことで、生成AIからマニュアル情報を検索・参照することができます。

概要