API連携とは、外部システムやアプリケーションからマニュアル情報を呼び出すための仕組みです。
APIを利用することで、Teachme Biz上からだけでなく外部システムからマニュアル情報を利用することが可能になります。
概要
対応プラン
本機能をご利用可能なプラン・オプションに関してはリンク先をご確認ください。
詳細
マニュアル一覧API
登録されているマニュアルのリストを取得できます。
マニュアル詳細API
マニュアルごとに、詳細情報を取得できます。
API詳細仕様
システム連携に必要な詳細仕様については、以下のドキュメントをご確認ください。
https://docs.api.teachme.jp
※ドキュメントは日本語で作成しています。必要に応じ、お手元で翻訳してご利用ください。
関連リンク
API連携用のクライアントIDを発行・削除する（Webブラウザ版）
Teachme Biz API特約
日本語：https://file.biz.teachme.jp/doc/teachmebiz_apiaccessplus_terms.pdf
英語：https://file.biz.teachme.jp/doc/teachmebiz_apiaccessplus_terms_e.pdf
よくある質問
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. システムとの連携については、お客様側でご対応いただく必要がございます。