BLOG /

microCMSのAPIキー権限で下書きが本番に漏れる原因

microCMSで「公開終了」にしたのに本番から消えない。原因はAPIキーの権限設定にある。本番用キーをGETのみにする手順と、権限が効いているかを確かめる方法を解説します。

microCMSで「公開終了」にしたコンテンツが、本番サイトから消えない。APIをたたくと totalCount が 1 のまま返ってくる。まず疑うのはCDNキャッシュではなく、APIキーの権限だ。

「下書き全取得」と「公開終了全取得」がONだと、ふつうのGETでも下書きと公開終了のコンテンツが返ってくる。本番ビルド用のキーはGETだけにする。この記事では、切り分けの手順と直し方、効いているかの確かめ方をまとめる。

症状:「公開終了」にしても、APIが返し続ける

管理画面でコンテンツを「公開終了」にしたのに、つぎのリクエストがそのコンテンツをふくめて返す。

curl -H "X-MICROCMS-API-KEY: $MICROCMS_API_KEY" \
  "https://$SERVICE_ID.microcms.io/api/v1/media"

レスポンスの totalCount は 1 のまま。単体取得のGETも 200 でなかみが返る。公開終了なら 404 になるはずなのに、だ。

キャッシュを疑うなら、?limit=99 のようにクエリをかえて、キャッシュキーをずらしてみる。キャッシュの問題なら、結果がかわる。かわらないなら、原因はべつの層にある。

原因:GETとは別にある「下書き全取得」「公開終了全取得」権限

microCMSのAPIキーには、GETとはべつの権限がある。「下書きコンテンツの全取得」と「公開終了コンテンツの全取得」だ。

これらがONのキーでふつうのGETをよぶと、下書きや公開終了のコンテンツまで返ってくる。つまり「公開終了にしたのに返る」のは、仕様どおりの動きだ。コンテンツの状態より、キーについた権限のほうが強く効く。

原因のキーを管理画面でひらくと、こうなっていることが多い。GET、下書き全取得、公開終了全取得、POST、PUT、PATCH、DELETE。7つすべてがONだ。

なぜ起きる:seed投入で全権限ONにしたキーが本番ビルドに残る

流れはこうだ。初期データ(seed)を流しこむスクリプトには、書きこみ権限がいる。コンテンツはPUTで入れ、画像はマネジメントAPIでアップロードする。作業中は全権限をONにするのが自然だ。

問題は、そのあとにある。権限をもどし忘れたまま、同じキーを Cloudflare Pages の環境変数に入れてしまう。作業用のキーが、そのまま本番ビルド用のキーになる。

制作側は下書き機能を使わないので、日ごろは気づけない。ふむのは、クライアントに管理画面をわたした瞬間だ。

  • 「下書き保存」した書きかけが、本番サイトに出る
  • 「公開終了にする」をおしても、本番から消えない
  • 「下書きはサイトに出ません」と書いた納品ガイドが、うそになる

もうひとつある。本番の環境変数にDELETE権限つきのキーが入っている状態は、それだけで過剰だ。ビルドのときに使うのは読みとりだけ。なのに、消せるキーをおいている。まんいちキーがもれれば、読まれるだけではすまない。

回避策:本番用キーはGETのみ。管理画面での変更手順

本番ビルド用のキーは、GETだけをONにする。ほかの6つはOFFにする。seedが必要なときは、べつのキーを発行するか、作業中だけ権限をもどす。

管理画面での変更はつぎの順だ。

  1. 管理画面で「権限管理」をひらく(「N個のAPIキー」と表示されている項目)
  2. 該当のAPIキーをえらぶ
  3. 「コンテンツAPI」タブをひらく
  4. GET以外のチェックをはずす
  5. 「変更」をおし、確認で「変更する」をおす

キーの文字列はかわらない。Cloudflare Pages の環境変数を入れ直さなくていい。ただし、静的に書きだすサイトなら、変更したあとにもういちどビルドして、古い出力を入れかえること。出力したHTMLには、公開終了のコンテンツが残っているからだ。

キーは用途で分けておくと、事故が減る。読みとり専用の本番キーと、書きこみ用の作業キー。名前も分けておけば、環境変数に入れるキーをとりちがえにくい。Production と Preview でべつのキーをおく手もある。

確かめ方:1件を公開終了にして、APIから消えるかを見る

権限の画面をながめるだけでは、見落としが起きる。動きで確かめるほうがはやい。

  1. 確認用のコンテンツを1件、「公開終了」にする
  2. 一覧のGETをよび、totalCount が減ったかをみる
  3. 単体のGETをよび、404 になるかをみる
curl -s -H "X-MICROCMS-API-KEY: $MICROCMS_API_KEY" \
  "https://$SERVICE_ID.microcms.io/api/v1/media?limit=1"

curl -s -o /dev/null -w "%{http_code}\n" \
  -H "X-MICROCMS-API-KEY: $MICROCMS_API_KEY" \
  "https://$SERVICE_ID.microcms.io/api/v1/media/$CONTENT_ID"

どちらかいっぽうでは足りない。一覧から消えて単体が 200 のまま、というずれもありうる。りょうほうをみておけば、権限が効いているかどうかを判断できる。

権限をなおしたのに結果がかわらないときは、そこではじめてCDNキャッシュを疑う。順番を逆にすると、キャッシュを消してまわるだけで終わる。

確認のあとは、コンテンツを公開にもどしておこう。納品前にこのテストをいちど通しておけば、クライアントがはじめて「下書き保存」をおす日にも、あわてずにすむ。

ほかの制作メモは /blog にも置いている。サイト制作の相談は /contact へ。