APIプレビュー

最終更新日: 2026/04/24

APIプレビュー機能では、コンテンツAPIのリクエストを管理画面上で実際に試すことができます。

事前準備

APIプレビューを利用する場合、呼び出すメソッドの権限が付与されたAPIキーが1つ以上作成されている必要があります。

APIキーの作成や権限設定については、以下のドキュメントをご参照ください。
APIキー（APIの認証と権限管理）

APIプレビューを利用する場合、APIキーの読み取り権限が付与されたロールが必要となります。

設定箇所については、以下のドキュメントをご参照ください。
ロール（管理画面の権限管理） > APIキー

コンテンツ一覧画面もしくはコンテンツ編集画面で［APIプレビュー］ボタンをクリックします。

APIプレビューの操作メニューが表示されるので、プレビューしたいメソッドやクエリパラメータ、リクエストボディを指定します。

リクエスト情報を指定したら、右上の［取得］（GET以外は［送信］）ボタンをクリックします。
すると、リクエスト内容に応じたレスポンス（ステータスコード、レスポンスボディ）が表示されます。

Caution: GET以外のメソッドでは、APIプレビューを実行すると、実際にコンテンツが登録されたり、削除されたりします。本番環境でお使いの場合は十分にご注意ください。

APIプレビューの操作メニューについて説明します。

HTTPリクエストのメソッド（GET／POST／PUT／PATCH／DELETE）を選択できます。
コンテンツ一覧画面かコンテンツ編集画面かによって利用できるメソッドは異なります。詳細は、下記のメソッドごとの説明を参照してください。

プルダウンメニューでエンドポイントを選択したり、自由に入力したりできます。
※自由入力はPUTメソッドのみ

リクエスト時に付与されるリクエストヘッダの一部が表示されます。この操作メニュー内では変更できません。

サービス内のAPIキーのなかで、該当メソッドの権限が付与されているものが自動でセットされます。セットできるAPIキーがない場合、必要な権限を付与したAPIキーを作成してください。
利用できるAPIキーが複数ある場合、セットされるAPIキーは不定となります。

リクエスト時に付与したいクエリパラメータを設定できます。
Keyではメソッドごとに有効な値のみを選択できます。Valueでは任意の値を指定できます。

任意のリクエストボディを指定できます。JSON形式で入力してください。
［reset］ボタンをクリックすると、入力内容が初期値に戻ります。

設定されたクエリパラメータやリクエストボディを元に、プログラミング言語ごとの記載方法を確認できます。

送信ボタン（GETメソッドの場合は［取得］ボタン）をクリックすると、実際にリクエストが送信されます。

以降、コンテンツAPIの各種メソッドの使い方を説明します。

リクエストに対するレスポンスが返却されます。レスポンスの詳細については、以下のページを参照してください。
DELETE /api/v1/{endpoint}/{content_id}

Caution: DELETEメソッドでAPIプレビューを実行した際にも、実際にAPIリクエストが送られコンテンツが削除されます。ご利用の際はご注意ください。