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

事前準備

APIキーの作成

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



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

APIキーの読み取り権限の付与

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

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

APIプレビューの使い方

1. ［APIプレビュー］ボタンをクリックする

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

2. メソッドやクエリパラメータ、リクエストボディなどを指定する

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

3. ［取得］をクリックする

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

操作メニューの説明

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

1. メソッド

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

2. エンドポイント

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

3. リクエストヘッダ（Headers）

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

X-MICROCMS-API-KEYについて

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

4. クエリパラメータ（Params）

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

5. リクエストボディ（Body）

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

6. 言語選択メニュー

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

7. 送信（取得）ボタン

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

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

GETメソッド

対象画面

• コンテンツ一覧画面
• コンテンツ編集画面

クエリパラメータ（Params）

GETメソッドで利用できるクエリパラメータを指定できます。
「Params」セクションの表内にある［+］ボタンをクリックして、任意のクエリパラメータを追加してください。



付与できるクエリパラメータは以下のページを参照してください。

• GET /api/v1/{endpoint}
• GET /api/v1/{endpoint}/{content_id}

レスポンス

登録されているコンテンツ内容に応じてレスポンスが返却されます。その他、詳細は以下のページを参照してください。
GET /api/v1/{endpoint}

POSTメソッド

対象画面

• コンテンツ一覧画面

クエリパラメータ（Params）

特定のクエリパラメータを指定できます。クエリパラメータの詳細については、以下のページを参照してください。
POST /api/v1/{endpoint}

Body（リクエストボディ）

任意のリクエストボディを指定できます。リクエストボディの詳細については、以下のページを参照してください。
POST /api/v1/{endpoint}

レスポンス

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

PUTメソッド

対象画面

• コンテンツ一覧画面
• コンテンツ編集画面

エンドポイント

PUTメソッドでコンテンツを登録する際、任意のコンテンツIDをエンドポイントに含める必要があります。

コンテンツ一覧画面の場合

コンテンツ一覧画面では、そのAPIのエンドポイントのみが入力されています。追加したいコンテンツのIDを / の後に入力してください。

コンテンツ編集画面の場合

コンテンツ編集画面では、編集画面として開いているコンテンツのIDがすでに入力されています。任意のコンテンツIDに変更してください。

クエリパラメータ（Params）

特定のクエリパラメータを指定できます。クエリパラメータの詳細については、以下のページを参照してください。
PUT /api/v1/{endpoint}

Body（リクエストボディ）

任意のリクエストボディを指定できます。リクエストボディの詳細については、以下のページを参照してください。
PUT /api/v1/{endpoint}

レスポンス

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

PATCHメソッド

対象画面

• コンテンツ編集画面

Body（リクエストボディ）

任意のリクエストボディを指定できます。リクエストボディの詳細については、以下のページを参照してください。
PATCH /api/v1/{endpoint}/{content_id}

レスポンス

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

DELETEメソッド

対象画面

• コンテンツ編集画面

レスポンス

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