こんにちは。
本日のmicroCMSの更新情報をお知らせいたします！

変更内容

本日からマネジメントAPIがご利用できるようになりました。

現状ベータ版としてのご提供となります。本リリースまでに、APIや仕様が変更される可能性があります。

マネジメントAPIは、コンテンツAPIでは取得・更新できない管理画面内のメタ情報 (公開状態や予約情報など) をAPI経由で扱える機能です。そして、今回対応したマネジメントAPIの主な内容は以下になります。

• コンテンツの一覧情報を取得するAPI
• コンテンツの詳細情報を取得するAPI
• コンテンツの下書き / 公開状態を変更するAPI

※マネジメントAPIは全プランでご利用できます。

今後はコンテンツの情報だけではなく、APIを使ってレビュー申請をしたり、メディアの情報を取得するなど、管理画面内のあらゆる操作を行うことができます。なので、これまで以上にAPIを使った操作の幅が広がることが期待できます。

ご利用方法

ここからはマネジメントAPIのご利用方法について説明していきます。

まずは、microCMSのAPIキーにマネジメントAPIの権限を設定していきます。サービス設定 -> APIキーから、マネジメントAPIのタブに移動してください。



エンドポイントは以下の通りです。service_idの部分はお使いのサービスIDを入力してください。

https://service_id.microcms-management.io/api/v1/

それでは、実際にマネジメントAPIのエンドポイントを実行してみましょう。ここではcurlを使った例をあげます。api_nameはご自身が作成したAPIのエンドポイントを入力してください。X-MICROCMS-API-KEYはマネジメントAPIの権限を追加したAPIキーを指定してください。

curl https://service_id.microcms-management.io/api/v1/contents/api_name -H "X-MICROCMS-API-KEY:  XXXXXXXXXX"

想定されるレスポンス例は以下になります。コンテンツの一覧情報には、公開状態のコンテンツだけではなく下書き状態のコンテンツも含まれます。

{
  "contents": [
    {
      "id": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "publishedAt": "2019-08-24T14:15:22Z",
      "revisedAt": "2019-08-24T14:15:22Z",
      "status": [
        "DRAFT"
      ],
      "draftKey": "draftKey",
      "createdBy": "string",
      "updatedBy": "string",
      // 予約が設定されていない場合nullが入る
      "reservationTime": {
        "publishTime": "2019-08-24T14:15:22Z",
        "stopTime": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "totalCount": 1,
  "offset": 0,
  "limit": 10
}

そのほか、コンテンツの詳細や公開情報の操作はドキュメントのマネジメントAPIの項目も合わせてご覧ください。

最後に

今回のマネジメントAPIの追加で、APIとして扱える幅が広がりました。今後も継続的に機能を強化していきます。ぜひご利用ください。

以上、本日の更新情報でした。


-----

microCMSは日々改善を進めています。
ご意見・ご要望は管理画面右下のチャット、公式Twitter、お問い合わせからお気軽にご連絡ください！
引き続きmicroCMSをよろしくお願いいたします！