こんにちは。本日の更新情報をお知らせします。
APIキーをX-MICROCMS-KEYにリニューアルを行いました。権限設定をさらに細かく設定できるようになりました。

変更内容の概要

APIキーのリニューアルを行いました。変更点の概要は以下の通りです。

• 従来のX-API-KEY, X-WRITE-API-KEY, X-DRAFT-KEYは統合され、X-MICROCMS-API-KEYに変更となります。
• X-MICROCMS-API-KEYではサービスごとや、APIごとにGET/POST/PUT/PATCH/DELETEの権限を設定できます。
• 従来のX-API-KEY, X-WRITE-API-KEY, X-GLOBAL-DRAFT-KEYはそのまま対応なしでご利用もいただけますが、移行を奨励します(今後の廃止についても検討中です)。

細かい変更点・実際の設定方法などはドキュメントも合わせてご覧ください。
https://document.microcms.io/content-api/x-microcms-api-key
この記事では、設定方法と旧APIキー（X-API-KEY）との変更点について解説します。

APIキー設定方法

新X-MICROCMS-API-KEYの設定方法を紹介します。
「サービス設定」の「APIキー」をクリックしてAPIキー一覧画面に遷移することができます。

APIキー管理一覧の「追加」ボタンをクリックして、APIキーを作成できます。
また各APIキーをクリックすることで、詳細画面で編集できます。

APIキーの作成画面は以下のようになります。
APIキーの権限はサービス全体のAPIキーの権限を設定する「①デフォルト権限」と各APIごとに個別の権限を設定する「②個別権限」があります(詳細は後述)。
それぞれ、必要なメソッドの権限を設定してAPIキーを作成してください。


「+ 個別権限を追加」をクリックすると、各APIを選択してAPIごとに追加できます。

現状、作成・編集・削除権限は「管理者」のみが行うことができます。またロール権限でその他の権限者の「読み取り」権限を設定することができます。

X-MICROCMS-API-KEYの作成方法については合わせてこちらのドキュメントをご覧ください。
旧X-API-KEY等からの移行については合わせてこちらのドキュメントをご覧ください。

権限設定の変更点

以前のX-API-KEY、X-WRITE-API-KEYなどでは、APIキーを作成すると、GET/POST/PUT/PATCH/DELETE権限がサービス全体に適用されてしまうという課題がありました。
今回のアップデートにより、サービス全体に適用される「デフォルト権限」と個別のAPIごとに権限が適用される「個別権限」がAPIキーに設定できるようになり、より安全にAPIキーをご利用いただけます。

デフォルト権限

サービス全てのAPIのデフォルト権限を設定できます。
設定できるメソッドは「GET」「下書き全取得」「POST」「PUT」「PATCH」「DELETE」です。
デフォルト権限はサービス全体の全てのAPIに適用されます。
下書き全取得とは旧X-GLOBAL-DRAFT-API-KEYにあたる権限です。この権限を付与することにより、下書き状態のコンテンツも取得できます。

個別権限

API単位で個別に権限を設定できます。指定したAPIに関してはデフォルト権限が上書きされます。
例えば、デフォルト権限で「GET」を指定し、個別権限設定で「POST」「PUT」権限を付与した場合、該当のAPIには「POST」「PUT」の権限が付与されることになります。この例のようにAPIの個別権限では、GETの権限が打ち消されます。

権限設定については以下のドキュメントも合わせてご覧ください。
https://document.microcms.io/content-api/x-microcms-api-key#h1875982dad

ユースケース

X-MICROCM-API-KEYの権限管理を活用いただくことで、要件に応じて権限を設定することができます。各プロダクト・プランに応じて適切な権限設定を行ってください。

• 書き込み系のメソッドの権限が付与されたキーを個別に管理する。
• 公開・非公開コンテンツで使い分ける
• WEB、iOS、AndroidなどマルチデバイスごとにAPIキーを使い分ける

その他にも「ランキング処理を行うバッチ処理用」や「ローカルでのデータを簡単に確認するための最低限の読み取り用」など、「開発をスムーズかつ安全に進めるための様々な用途」が考えられます。
以下のドキュメントにこれらのユースケースの詳細をまとめさせていただいたので、合わせてご覧ください。
https://document.microcms.io/content-api/x-microcms-api-key#h9ab4ef6b46

SDK

• microcms-js-sdkはv2.0.0から対応済です。 https://github.com/microcmsio/microcms-js-sdk
• microcms-ios-sdkはv2.0.0から対応済です。https://github.com/microcmsio/microcms-ios-sdk
• microcms-android-sdkはv2.0.0から対応済です。https://github.com/microcmsio/microcms-android-sdk
• gatsby-source-microcmsはv2.0.0から対応済です。https://github.com/microcmsio/gatsby-source-microcms
• nuxt-microcms-moduleはv2.0.0から対応済です。https://github.com/microcmsio/nuxt-microcms-module

料金

各プランのAPIキーの作成可能個数は下記の通りです。

Hobbyプラン：1個
Standard・旧Starter・旧Standard プラン：3個
Business・旧Businessプラン：10個
Enterpriseプラン：カスタム

プランの詳細については料金ページをご覧ください。
https://microcms.io/pricing

※ステージング環境では、環境ごとに3個のAPIキーを作成することが可能です。
※Hobbyプランをご利用の場合は一度旧APIキーを削除し、再度APIキーを作成いただくことで、X-MICROCMS-API-KEYをご利用いただけます。

最後に

X-MICROCMS-API-KEYへのリニューアルによって、プロダクトごとに適切なAPIキーの権限設定ができるようになり、より安全にサービスをご利用いただけるようになるかと思います。ご確認ください！

-----

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