APIの呼び出し
最終更新日:2023年05月29日
コンテンツを作成した後は、API経由でコンテンツを取得してみましょう。
単一コンテンツの取得
コンテンツをひとつだけ取得したい場合は、次のエンドポイントを利用します。
GET /api/v1/{endpoint}/{content_id}
- GET /api/v1/{endpoint}/{content_id}
- https://document.microcms.io/content-api/get-content
APIを呼び出すためにはAPI-KEYが必要です。
API-KEYは権限管理 > X個のAPIキーから確認可能です。
また、microCMSには管理画面上で簡単にAPIを試すことができる「APIプレビュー」機能が標準で搭載されています。
コンテンツ編集画面の右上に「APIプレビュー」ボタンがあるのでクリックしてみましょう。
既にデータ取得リクエストの準備は整っています。
画面内の「取得」ボタンを押してみましょう。
実際にブラウザからAPIリクエストが行われ、次のようなJSONレスポンスが表示されます。
また、画面内にはAPIを叩くためのcurlコマンドも表示されています。
こちらで直接データを取得することも可能です。
$ curl "https://micro.microcms.io/api/v1/news/FwVfA_GeL" -H "X-MICROCMS-API-KEY: 1598164e-2d58-488c-a4af-c51bd7d131a5"
そのほかAPI仕様の詳細についてはコンテンツAPIリファレンスをご覧ください。
コンテンツ一覧の取得
リスト形式のAPIでは次のエンドポイントを利用することで、コンテンツ一覧の取得を行うことも可能です。
GET /api/v1/{endpoint}
- GET /api/v1/{endpoint}
- https://document.microcms.io/content-api/get-list-contents
こちらのAPIに関しても、コンテンツ一覧画面右上の「APIプレビュー」ボタンから実行が可能です。
リスト形式のAPIでは入稿したコンテンツが配列で返ってくると共に、totalCount、offset、limit が返却されます。
コンテンツ一覧取得APIはクエリが豊富で、フィールド指定や複雑なフィルタリングを行うことができます。
コンテンツの作成