場所: 設定 → 高度な設定 → 他のアプリと連携
このページを開く: admin.<your-site>/settings/integrations(<your-site> をご自身のサイトアドレスに置き換えてください)。メニューに表示されない場合は、設定ページで すべての設定を表示 を有効にしてください。
事前準備
- キーを作成できるのはサイト所有者のみです。
手順
- 設定 → 高度な設定 → 他のアプリと連携 → APIキー を開きます。
- キーを作成 を押します。
- 名前(例: 「提携ウェブサイト」)を入力します。
- できること? の下で必要な項目にチェックを入れます:
- 記事の読み取り: 公開済みの記事(有料限定テキストを除く)。
- 有料記事の全文読み取り: 有料記事の全文も含む。
- 下書きの送信: 記事を下書きとして追加。チームの確認なしに公開されることはありません。
- 写真の送信: ウェブアドレスからメディアライブラリに写真を追加。
- セクションとタグの読み取り。
- アクセス数の読み取り: 記事の閲覧数と合計訪問者数。
- 収益レポートの読み取り: 合計のみ、読者情報は含まれません。
- 任意: 有効期限、これらのアドレスからのみ(1行に1つ、最大20件)、1分あたりのリクエスト数(1〜600)、1日あたりのリクエスト数(1〜1,000,000)を設定します。
- キーを作成 を押します。
- ボックスからキーをコピーします。キーが表示されるのはこの時だけです。保存しました を押します。
- そのキーを相手のアプリに渡します。アプリは "Authorization: Bearer" ヘッダーにキーを含めて送信します。
補足情報
- 一覧には各キーの 名前、許可する操作、最終利用、有効期限、ステータス(正常、期限切れ、停止中 のいずれか)が表示されます。
- 新しいキーを発行しますか? はキーを置き換えます。古いキーは指定した期間引き続き動作しますが、漏洩した可能性がある場合は 今すぐ停止 を選択してください。
- キーを停止 はそのキーを使ったすべてのリクエストを直ちに拒否します。この操作は取り消せません。アプリのアクセスを再度許可するには新しいキーを作成してください。
- キーの詳細には過去30日間の使用状況が表示されます。
- 各キーには独自の制限があります。リクエスト頻度が高すぎるアプリは速度が制限されます。
- 有料限定テキストの権限を持つキーがあると、それを持つ誰もが読者が料金を支払っている記事を読めるようになります。安全に管理してください。
トラブルシューティング
- "作成可能なキーの上限数に達しました。まずは使わなくなったキーを停止してください。"
- "キーに名前を付けてください。"
- "キーで実行できる操作を少なくとも1つ選択してください。"
- "将来の日付を選択してください。"
よくある質問
よくある質問
後からキーを再度確認できますか?
いいえ。代わりに新しいキーを作成してください。
1つのキーを複数のアプリで使用できますか?
使用は可能ですが、1つだけを停止できるようにアプリごとに専用のキーを割り当ててください。