Channel Developers

thumbnail

Authentication

Documents Open APIを利用するためのAPIキーの発行手順と、それを用いた認証方法についてのガイドです。

ドキュメント機能のリソースは「スペース」単位で管理されます。ご利用ガイドに従い、スペース設定メニューからAPIキーを作成してください。発行されたAPIキーはそのスペース内の全リソースにアクセスできますが、他のスペースの記事やエンティティにアクセスすることはできません。

APIキーを発行した後、生成されたアクセスキーアクセスシークレットを保存する必要があります。新しいAPIキーの作成を完了すると、アクセスシークレットを表示することはできません。アクセスキーとシークレットは、スペース内のあらゆるリソースやドキュメント(未公開のものを含む)へのアクセスに使用できるため、安全に保管する必要があります。

APIキーを削除すると、削除されたキーのアクセスキーとシークレットは直ちに無効化されます。

アクセスキーとシークレットを取得すると、それを使用してREST APIへの認証を行うことができます。キーとシークレットは、以下のようにBasic認証で提供される必要があります。

Shell

<credentials>は、<access_key>:<access_secret>をbase64エンコードしたものにする必要があります。