microCMS

チュートリアル
操作マニュアル
コンテンツAPI
マネジメントAPI（ベータ）
画像API

旧API（X-API-KEYなど）からの移行

旧形式APIキー（X-API-KEY、X-WRITE-API-KEY、X-DRAFT-API-KEY）からX-MICROCMS-API-KEYへの移行について解説します。

X-MICROCMS-API-KEYについてはこちらのページをご覧ください。

X-MICROCMS-API-KEYへの移行について

以前は X-API-KEY などのヘッダを使ってリクエストを行なっていただく必要がありました。

$ curl "https://<subdomain>.microcms.io/api/v1/<endpoint>" \
    -H "X-API-KEY: <旧APIキー>"

$ curl "https://<subdomain>.microcms.io/api/v1/<endpoint>" \
    -H "X-API-KEY: <旧APIキー>" \
    -H "X-GLOBAL-DRAFT-KEY: <旧APIキー>"

$ curl -X POST "https://<subdomain>.microcms.io/api/v1/<endpoint>" \
    -H "X-WRITE-API-KEY: <旧APIキー>"


現在はAPIキーは X-MICROCMS-API-KEY ヘッダに統一されており、各種権限管理がこれまで以上にわかりやすくできるようになりました。
https://document.microcms.io/content-api/x-microcms-api-key

X-API-KEYなど今後も旧ヘッダは使えますが、移行することを推奨します。（廃止についても検討中です）
移行時のコマンド実装例：

$ curl "https://<subdomain>.microcms.io/api/v1/<endpoint>" \
    -H "X-MICROCMS-API-KEY: <旧APIキー>"


旧形式APIキーでX-API-KEY、X-WRITE-API-KEY、X-DRAFT-API-KEYを作成していた場合、それぞれ3種類のX-MICROCMS-API-KEYが生成されています。
各旧APIキーのデフォルト権限は以下の通りです。HTTPメソッド https://blog.microcms.io/http_post_api/ の設定を行なっていた場合は個別権限として移行されています。
　・X-API-KEY → GET のみtrue
　・X-WRITE-API-KEY → すべてfalse
　・X-GLOBAL-DRAFT-KEY → 全ての下書きのみtrue

SDK