API Key¶

API Key とは¶

Mapray Cloud のリソースへアクセスするときに使用します。
Organization 管理者は API Key の作成・更新・削除を行えます。

Warning

API Key にはスコープがないため、Web ページなどのクライアントに埋め込むと、取得した第三者が組織のデータセットの削除・更新まで行えてしまいます。クライアントに埋め込む場合は、必要なスコープ（データセットを表示するだけであれば dataset:read）のみを付与した Organization token を使用してください。

作成数の上限¶

Organization に紐づいた API Key の数に制限があります。
作成できる API Key の数は 500 個です。

API Key の取得¶

Mapray Cloud にサインインし、右上の「メニュー」から「Tokens」を選択します。すると、以下のような画面が表示されます。

api-key_01

このAPI Key画面で「New API Key」ボタンを押すと「New API Key」ダイアログが表示されます。

api-key_02

ダイアログが表示されたら、必要事項を入力します。

プロパティ	説明
Name	任意の名前を指定します。
Allowed Domains	アクセスを許可するドメインを複数設定できます。ドメインを設定しない場合はドメインの制限は行いません。

入力が完了したら OK をクリックします。

api-key_03

作成した Key は一覧で確認できます。