はじめの設定 11 / 14
API キーの扱いと安全
CMS のトークンや API キーは、サイトの中身を書き換えられる鍵です。付ける権限は最小にし、決まった場所にだけ置き、漏れたかもしれないときにはすぐ止められるようにしておきます。このページでは、お客様にしていただくことと、get1pct がキーをどう扱っているかを説明します。
- 必須かどうか
- つなぐ前に
- 作業をする場所
- 各 CMS と、管理画面
権限は最小にする
キーは get1pct 専用に、ほかの用途とは分けて作ります。付けるのはget1pct が実際に使う権限だけです。
- Shopify: アプリのスコープは、
write_productsとwrite_content(またはwrite_online_store_pages)だけにします。注文・顧客・テーマなどは付けません。手順 - Webflow: サイトトークンは、CMS を Read and write、Sites を Read-only、ほかを No access にします。手順
- Contentful: トークンには、作った人の権限がそのまま付きます。つなぐスペースだけに、公開できる役割(Editor など)で get1pct 用のユーザーを入れ、そのユーザーで作ります。Admin は要りません。手順
- microCMS: 最初から付いているデフォルト権限の GET を外し、つなぐ API にだけ GET と PATCH を付けます。手順
- WordPress: アプリケーションパスワードは、投稿や固定ページを編集できるユーザーで作ります。管理者でなくても構いません。手順
- get1pct の API キー(opct_): 案を読むだけなら、「自社サイトから改善案の反映結果を記録できるキーを発行する」にチェックを入れずに発行します。手順
キーの置き場所
- CMS のトークンは、get1pct の管理画面の入力欄にだけ貼ります。メール、チャット、お問い合わせのフォーム、共有の文書には書かないでください。お問い合わせのときにも、キーは送らないでください。
- get1pct の API キー(opct_)は、自社のサーバーにだけ置きます。環境変数やシークレットの保管場所(クラウドのシークレット管理など)に入れ、ブラウザーで動くコード(
NEXT_PUBLIC_などで公開される変数を含む)、スマホアプリ、Git、ログには書かないでください。 - キーを扱う人を決めておきます。担当者が替わるときは、引き継ぎをして、キーを作り直します。
漏れたかもしれないとき
キーを誤って送った、公開の場所に書いた、パソコンをなくした、などのときは、すぐに次の順で止めてください。
- キーを発行したサービスの側で無効にする。これでそのキーはどこからも使えなくなります。無効にする方法は、Shopify はアプリのアンインストールか削除、Webflow はトークンの Revoke、Contentful は CMA トークンの Revoke、microCMS は API キーの削除、WordPress はアプリケーションパスワードの取消です。
- get1pct の管理画面の「サイトの接続」で「接続を切る」を押す。get1pct がお預かりしているキーを消します。
- get1pct の API キー(opct_)は、管理画面の「API」で「キーを無効にする」か「キーを発行・更新」を押す。どちらを押しても古いキーはその場で使えなくなります。
- 新しいキーを作って、つなぎ直す。あわせて、CMS の側の変更の履歴で、身に覚えのない書き換えが無いかを確かめてください。
作り直す時期
- 担当者が替わったとき、外部の制作会社との契約が終わったとき、使い道が変わったときは、キーを作り直します。
- それ以外のときも間隔を決めて定期的に作り直すと安全です。Contentful のように有効期限を選べるものは、期限を付けて作ります。
- get1pct の API キー(opct_)は、「キーを発行・更新」を押すと新しいキーに替わり、前のキーはすぐに使えなくなります。自社のサーバーの値をすぐに差し替えられるよう、作業の時間を決めてから押してください。
get1pct での扱い
ここに書いたことは、どれも get1pct のプログラムの実際の動きです。
- CMS のトークンと WordPress のアプリケーションパスワード: サーバーだけが持つ鍵で暗号化(AES-256-GCM)して保存し、画面や API には返しません。暗号文はそのサイトの接続に結びつけているので、別のサイトの記録へ写しても読めません。使うのは、選んだ案を反映するときと、取り消すときだけです。
- 接続する先: CMS へは、各 CMS の公式の API のホスト(
*.myshopify.com・api.webflow.com・api.contentful.com/api.eu.contentful.com・*.microcms.io)にだけ接続します。入力された URL や案のページの URL をそのまま使うことはなく、転送(リダイレクト)にも従いません。そのため、キーがほかのホストへ送られることはありません。 - 消すとき: お預かりしたキーは、「接続を切る」を押したとき、解約したとき、Pro で追加したサイトを外したときに消します。
- 接続を試せる回数: キーを総当たりで試せないよう、お一人あたりとサイトあたりで、それぞれ 1 時間に 10 回までにしています(すべてのサーバーで共通に数えます)。つながらなかった理由も、細かくは返しません。
- get1pct の API キー(opct_): ランダムな 32 バイトから作り、保存するのは SHA-256 のハッシュだけです。キーそのものは発行したときに 1 度表示するだけで、get1pct にも残りません。使えるのはご契約が Growth・Pro の間だけで、1 つのキーで 1 分に 60 回までです。
- API はサイトに書き込まない: get1pct の API が扱うのは、案と反映の記録だけです。あなたのサイトに書き込んだり公開したりはしません。API を呼んだ側が指定した URL にも接続しません。
持ち主の確認の 1 行(get1pct-verification)は秘密ではなく、公開ページに置くためのものです。API キーとは別物です。
使わなくなったら
get1pct の側で接続を切り、キーを発行したサービスの側でもキーを消します。両方で消して、はじめてキーが無くなります。解約するときに外すものは、お支払いの変更・解約にもまとめています。
手順のとおりに進まないときは、お問い合わせから、対象のサイトの URL と、どの画面で止まったかをお知らせください。パスワードは送らないでください。