microCMS

APIプレビュー

最終更新日:2023年01月23日

APIの呼び出しを管理画面上で実際に試すことができます。
GET APIはもちろん、POST、PUT、PATCH、DELETEそれぞれ呼び出し可能です。

基本的な使用方法

コンテンツ一覧画面もしくはコンテンツ詳細画面の右上あたりにある「APIプレビュー」から利用します。

▼コンテンツ一覧画面


▼コンテンツ詳細画面

GET

GET APIのAPIプレビューはコンテンツ一覧画面、コンテンツ詳細画面ともに使用可能です。

例として一覧画面での使用方法をご紹介します。
一覧画面で「APIプレビュー」のボタンをクリックすると、以下のようなメニューが開かれます。



そのまま「取得」ボタンをクリックすると、以下のように実際に取得できるレスポンスが表示されます。

パラメータの付与

GET APIで使用できるパラメータをAPIプレビューでも試すことができます。

「Params」セクションのテーブルに「+」ボタンがありますので、そちらをクリックいただくと、パラメータを追加することができます。



パラメータを追加すると「Params」セクションのテーブルにkeyとvalueが設定されます。
keyにはその時追加されていないパラメータが自動的に設定されますので、適宜変更ください。

そして下線部分に注目いただきたいのですが、それぞれのSDKでの利用例にもパラメータの実装が追加されます。


POST

POST APIのAPIプレビューはコンテンツ一覧画面でのみ使用可能です。

GET APIと同様にAPIプレビューのメニューを開きます。
その後、「GET」と表示されているプルダウンをクリックすると以下のような表示になります。



ここで「POST」を選択することでPOST APIを実行するように変更できます。
変更すると以下のようにGET APIとは違った表示になります。



先ほどはなかった「Body」セクションがあります。
こちらに追加したいコンテンツのデータをJSON形式で入力し、「送信」ボタンをクリックします。
そうするとPOSTリクエストが実行されますので、その後コンテンツ一覧画面に戻ると追加されていることを確認できます。

PUT

PUT APIのAPIプレビューはコンテンツ一覧画面、コンテンツ詳細画面ともに使用可能です。

使い方はPOST APIとほとんど同様ですが、追加したいコンテンツのIDをエンドポイントに入力する必要がある点だけ異なります。



一覧画面からAPIプレビューのメニューを開いた場合は、そのAPIのエンドポイントのみが既に入力されていますので、追加したいコンテンツのIDを / の後に入力します。
詳細画面の場合は開いているコンテンツのIDが既に入力されていますので、その部分を変更する形となります。

PATCH

PATCH APIのAPIプレビューはコンテンツ詳細画面でのみ使用可能です。

使い方はPUT APIとほとんど同様ですが、「Params」セクションがない点と「Body」セクションにおいて更新したいフィールドのみを入力する点が異なります。

DELETE

DELETE APIのAPIプレビューはコンテンツ詳細画面でのみ使用可能です。

使い方はPUT APIとほとんど同様ですが、「Params」セクションと「Body」セクションがない点が異なります。

informationInformation

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

注意点

APIプレビューをご利用していただく中でいくつかご留意いただきたい点がございます。

APIキーの権限設定

GET API以外のリクエストをお試しいただく場合は、あらかじめそのメソッドに対応したAPIキーを作成しておく必要があります。

サービスを作成した際に自動的に作成されるAPIキーはGET APIのみ有効化されています。
そのためたとえばPOST APIを試したい場合は、既にあるAPIキーの権限にPOST APIを追加するか、



POST APIを有効化したAPIキーを新たに作成します。

マネジメントAPIのプレビュー

現状マネジメントAPIについてのAPIプレビューは非対応となります。