API キー · Measure Map Online ヘルプ

ウェブサイトやソフトウェアを Measure Map Online に接続するキーを作成し、できることを選び、本番とテストの作業を分け、安全に置き換えたり制限したりする方法を説明します。

API キーを使うと、自分のウェブサイトやソフトウェアを Measure Map Online のアカウントと連携させられます。サイトにプロジェクトの地図を表示したり、訪問者のためにプロジェクトを始めたり、REST API でプロジェクトを読み取って変更したりできます。キーは開発者ページで作成・管理します。

開発者ページを開く#

ダッシュボードのメニューで、詳細の下の開発者を押します。API キーが表示された状態で開き、その他のセクションはメニューのその下に表示されます（スマートフォンでは、ページ上部のタブとして表示されます）。

ゲストリンク（Open Guest）：ウェブサイト用の、コード不要のリンク。詳しくはOpen Guestを参照してください。
API を試す、Webhook、REST API：API リファレンスを参照してください。
地図を埋め込む（Enterprise）：iFrame APIを参照してください。

キーのカードの上部のバッジには、キーの状態が表示されます。アクティブ、未アクティブ化（キーがまだない）、無効（API アクセスが停止されている。どのキーも動作せず、サポートが停止を解除するまで新しいキーも作成できません）、期限切れ（サブスクリプションが有効でない）のいずれかです。

サンドボックスのキー、キーでできること、表示ボタンとコピーボタンがある「API キー」セクション

本番とサンドボックス#

キーのカードの上部で、本番と サンドボックス を切り替えます。それぞれに専用のキーがあり、ページには選んだほうのキーが表示されます。この選択は API を試すにも適用され、セクション間を移動しても保たれます。地図を埋め込むとゲストリンクは常に本番のキーを使います。ウェブサイトの訪問者が開けるのは本番のプロジェクトだけだからです。どちらかを開くと、ページは本番に戻ります。

本番は実際のアカウントで、ページはこの状態で開きます。ウェブサイトでは本番のキーを使います。
サンドボックス は、連携を開発・テストするためのものです。サンドボックスのキーで作成したプロジェクト、フォルダ、製品は、実際のものとは分けて保管されます。本番のキーからはそれらが見えず、サンドボックスのキーからは本番のものが見えません。サンドボックスのキーでのリクエストは利用状況の数値に含まれず、サンドボックスのキーで作成したゲストプロジェクトが課金されることもありません。

新しいサンドボックスのキーを作成しても本番のキーには影響せず、その逆も同じです。

キーでできることを選ぶ#

新しいキーのアクセス権 では、各行が API の 1 つの領域です。次に作成するキーが、その領域にどこまでアクセスできるかを選びます。

領域	選択肢	許可される内容
埋め込みマップ	アクセスなし、許可	埋め込みマップに閲覧者をサインインさせます。ほとんどの連携はこれだけで足ります。
プロジェクト	アクセスなし、読み取り、読み取りと変更	プロジェクトとフォルダ、その計測値・コメント・エクスポート。
ユーザー（Enterprise）	アクセスなし、読み取り、読み取りと変更	アカウントのメンバーとそのシート。
製品	アクセスなし、読み取り、読み取りと変更	製品カタログと価格。

選択肢にポインターを合わせると、何が許可されるかが正確に表示されます。最初のキーは 埋め込みマップ だけの状態で始まり、埋め込みマップに必要なのはこれだけです。別のキーを置き換えるキーは、置き換えるキーと同じアクセス権で始まります。少なくとも 1 つの領域を選んでください。API で組織のメンバーとしてサインインするには、埋め込みマップ ではなく、ユーザー：読み取りと変更 が必要です。

キーでできることは、作成時に決まります。キーのアクセス権を広げたり狭めたりするには、新しいキーを作成します。

キーを作成する#

本番または サンドボックス を選びます。
新しいキーのアクセス権 でアクセス権を設定します。
必要に応じて、キーを見分けられるように 新しいキーの名前（任意） に名前を入力します。
新しいキーを生成を押します。

キーは あなたの API キー の下に、最初と最後の数文字以外を隠した状態で、キーの権限を示す行とともに表示されます。を押すとキー全体が表示され、を押すとキー全体がコピーされます。アカウントでキーが作成されるたびに、メールが届きます。

アクセス領域の導入前に作成されたキーは、製品の操作とメンバーとしてのサインインを除く、すべての操作ができます。カードにはその旨の警告が表示されます。埋め込みにしか使わない場合は、より狭いキーに置き換えてください。

キーを置き換える#

キーがある状態で、もう一度新しいキーを生成を押します。先に警告が表示されます。新しいキーを作成します。現在のキーは 24 時間有効なままなので、その間に利用中のサイトを更新できます。完了すればそれより早く失効させることもできます。

古いキーは、残り時間と最後に使われた日時とともに 以前のキー に移動します。新しいキーへの切り替え中も引き続き使用できます。使われなくなったらすぐに失効させてください。すぐに停止するには、失効を押して確定します。まだそのキーを使っているサイトは、すぐに動作しなくなります。キーが失効すると、メールが届きます。

ウェブサイトの制限は、新しいキーにコピーされます。新しいキーを作成できるのは、1 分に 1 回程度です。

キーを自分のウェブサイトに限定する#

このリストのウェブサイトだけが、ブラウザーでキーを使用できます。他のサイトのページからの埋め込みマップやリクエストは拒否されます。サーバーからの呼び出しには影響しません。

ウェブサイトの制限 で、ウェブサイトまたはドメインを入力してください にサイトを入力します。example.com のようなドメイン、IP アドレス、localhost のいずれかです。完全なアドレスを貼り付けることもできます。その場合は、https://、パス、ポートを除いたサイト名だけが保存されます。
追加を押します。

ドメインにはそのサブドメインも含まれます。example.com を追加すると shop.example.com も許可されます。サイトを削除するにはを押して確定します。最後の 1 つを削除すると、キーはどのウェブサイトからでも使えるようになります。キーからウェブサイトが削除されるたびに、メールが届きます。

この一覧はブラウザーに適用されます。埋め込みマップは、一覧にあるウェブサイトのページでだけ開きます。ブラウザーがどのページにあるかを示さない場合は拒否されます。Web ページから送られる REST API のリクエストは、一覧にあるウェブサイトから来る必要があります。自社のサーバーからのリクエストはウェブサイトを示さないため、確認されません。Measure Map Online 自体は常に許可されるので、このページのプレビューは引き続き動作します。

キーの使われ方を確認する#

利用状況 は本番のキーすべてを合計するので、キーを置き換えても数値は続きます。直近 30 日間のリクエストが、埋め込みマップと REST API の両方について、日ごとの棒グラフで表示されます。累計の合計、最終アクセス、現在のキーの作成日時（キーの作成日）、上位ドメイン（キーを最も多く使っているウェブサイト）も表示されます。見覚えのないウェブサイトがある場合は、キーを制限するか置き換えてください。

サンドボックスのリクエストは数えられないため、数値は本番でだけ表示されます。このページ自体が API を試すやプレビューで行うリクエストも数えられません。

キーを安全に保つ#

各キーには、必要なアクセス権だけを与えます。Web ページで使うキー（たとえば埋め込みのアドレスに入れるキー）は、埋め込みマップ だけにしてください。
このキーはデータを変更できます。Web ページやアプリには入れず、サーバーで保管してください。
Web ページで使うキーは、自分のウェブサイトに限定します。
画面を共有するときは、ページのキーを隠したままにします。コピーするのに表示する必要はありません。
キーが漏れた可能性がある場合は、新しいキーを作成し、以前のキー で古いキーをすぐに失効させます。
開発とテストには サンドボックス のキーを使い、試験的な操作が実際のプロジェクトに混ざらないようにします。