Documents Open APIを使用すると、開発者は「ドキュメント（Documents）」機能と連携したアプリケーションを構築できます。このAPIは、主に以下のユースケースで活用いただけます。
チャネルトークの「ドキュメント」で管理している記事などのリソースを埋め込み、完全にカスタマイズされた自社サイトを構築できます。
チャネルトークの「ドキュメント」から記事を書き出せます（現在はHTML形式に対応）。
外部のドキュメントをチャネルトークの「ドキュメント」へ取り込めます。
「ドキュメント」では、ユーザーガイド、ブログ、リリースノート、開発者ドキュメントなどのナレッジベース（記事や文書）を一元管理できます。
ステップ1： ガイドに従い、ワークスペース内に新しい「スペース」を作成します。
ステップ2：スペース設定からAPIキーを発行します。このキーはOpen APIの認証に使用されます。詳細はご利用ガイドをご参照ください。
ステップ3：Documents Open APIを使用してアプリを構築します。
「ドキュメント」機能全般についてはご利用ガイドを、開発やOpen APIに関連するリソースについては本ドキュメントをご参照ください。
Documents Open APIはREST APIとして提供されており、https://document-api.channel.ioからアクセス可能です。
カテゴリー | 説明 |
|---|---|
バージョニング | REST APIの現在のバージョンは v1 であり、 |
認証 | 発行されたAPIキーを使用した基本認証を行います。詳細については「認証」ページをご参照ください。 |
レート制限 | Documents REST APIを使用するクライアントは、レート制限の制約に従う必要があります。デフォルトでは、1つのスペースに対するすべてのリクエストは1秒あたり10リクエストに制限されます。この制限を超えたリクエストには、HTTPステータス 429 (Too Many Requests) が返されます。 |
形式（フォーマット） | すべてのリクエストおよびレスポンスデータはJSON形式で提供されます。 |
エラー | 問題が発生した場合は、適切な HTTPステータスコード（4xx または 5xx） と、エラーメッセージを含むHTTPレスポンスボディが返されます。 |