API キーの取得
出典：Security and authentication guide - Tutorial: Create an API key
APIキーの認証情報を使用してAPIキーを作成し、管理する方法を学びます。
API キーとは
API キーは、ArcGIS の安全なサービス、コンテンツ、および機能へのアクセスをアプリケーションに許可する、長期間のアクセス トークンです。API キーは、ポータルでホストされているアイテムの一種である API キーの認証情報を使用して生成されます。API キーの認証情報には、API キーを生成し、その権限や有効期限などのプロパティを管理するための設定が含まれています。 API キーの認証情報を作成し、アプリケーションで API キーを使用するプロセスは、API キー認証として知られています。
このガイドでは、APIキーの認証情報を作成し、以下のことを行う方法を説明します。
- 長期的な API キーを生成し、アプリケーションに保存
- API キーが ArcGIS のサービス、コンテンツ、および機能にアクセスできる権限の設定
- API キーの有効期限と参照元 URL の設定
- API キーの認証情報のアイテムページを使用した、API キーの管理
API キーの詳細については Introduction to API key authentication (英語) をご参照ください。
前提条件
- ArcGIS Location Platform アカウントまたは ArcGIS Online アカウントが必要です。ArcGIS Online アカウントをお持ちの場合は、アカウントに管理者権限または API キーの生成権限を持つカスタム ロールが設定されている必要があります。詳細については、Limitations を参照してください。
- アプリケーションに必要な権限を確認します。詳細は Privileges を参照してください。
API キーの作成手順
ポータルにサイン イン
APIキーの認証情報を含むアイテムの作成と管理にはポータルを使用します。
- ArcGIS.com にアクセスします。
- ArcGIS アカウントでサイン インします。
新しいアイテムの作成
- ポータルで、[コンテンツ] > [マイ コンテンツ] > [新しいアイテム] をクリックします。
- [開発者の認証情報] > [API キーの認証情報]を選択し、[次へ] をクリックします。
ArcGIS Online アカウントの場合は、アカウントに管理者権限または API キーの生成権限を持つカスタム ロールが設定されている必要があります。詳細については、Limitations を参照してください。
有効期限と参照元 URL の設定
API キーの認証情報は、API キーと呼ばれる長期間のアクセス トークンを生成します。API キーの有効期限は生成時に設定されます。また、APIキーに参照元を設定し、許可されたドメインからのみ使用できるように制限することもできます。
- [開発者の認証情報を作成] ウィンドウで、有効期限日をクリックします。アクセス トークンの有効期限を最大1年後まで設定できます。
- 参照元 URL でアクセス トークンを制限したい Web ドメインを設定します。これはセキュリティのために強く推奨されます。参照元の詳細については、API key credentials をご覧ください。
- [次へ] をクリックします。
アクセス トークンの有効期限と参照元 URL は、トークンを無効にしない限り変更できません。
権限の選択
開発者の認証情報を使って、アクセス トークンの権限を設定します。アクセス トークンがアプリケーションで動作するためには、アプリケーションが使用するコンテンツやサービスにアクセスするための適切な権限が必要です。必要な権限を選択して、API キーのアクセス トークンに適用します。
トークンに必要な権限は、アプリケーションに必要なコンテンツ、サービス、機能によって異なります。チュートリアルを行う場合は、そのアクセス トークンのセクションで必要な権限のリストを参照してください。
- [開発者の認証情報を作成] の [権限] ウィンドウで利用可能な権限を参照します。
開発者の認証情報に権限が表示されない場合は、次の理由により利用できない可能性があります。
・アカウントに正しいユーザー タイプまたはロールが設定されていない。
・サブスクリプションのタイプが間違っている。一部の権限は ArcGIS Location Platform ユーザーのみが使用でき、一部の権限は ArcGIS Online ユーザーのみが使用できます。
・ArcGIS Location Platform アカウントで従量課金が有効になっていない。
・必要な権限をサポートしないタイプの認証を使用している。詳細は、Types of authentication を参照してください。
以下の表を参照して、アカウントの種類に応じて利用可能なロケーションサービスについて確認してください。
ArcGIS Location Platform アカウントの場合
| カテゴリー | ラベル | 権限の文字列 | 説明 |
|---|---|---|---|
| ベースマップ | ベースマップ スタイル サービス | premium:user:basemaps |
アプリケーションがベースマップ スタイル サービスにアクセスできるようにします。 |
| データ エンリッチメント | ジオエンリッチメント サービス | premium:user:geoenrichment |
アプリケーションがジオエンリッチメント サービスにアクセスできるようにします。詳細はこちら。 |
| ジオコーディング | 住所検索 (データ保存する) | premium:user:geocode:stored |
アプリケーションがジオコーディング サービスにアクセスし、データを保存するジオコーディングを実行できるようにします。詳細はこちら。 |
| ジオコーディング | 住所検索 (データ保存しない) | premium:user:geocode:temporary |
アプリケーションがジオコーディング サービスにアクセスし、データを保存しないジオコーディングを実行できるようにします。詳細はこちら。 |
| プレイス | プレイス検索 | premium:user:places |
アプリケーションがプレイス サービスにアクセスできるようにします。詳細はこちら。 |
| ルート検索 | ルート検索 | premium:user:networkanalysis:routing |
アプリケーションがルーティング サービスにアクセスし、標準的なルート検索処理を実行できるようにします。詳細はこちら。 |
| ルート検索 | 最寄りの検索 | premium:user:networkanalysis:closestfacility |
アプリケーションがルーティング サービスにアクセスし、最寄りの検索を実行できるようにします。詳細はこちら。 |
| ルート検索 | ロケーション アロケーション | premium:user:networkanalysis:locationallocation |
アプリケーションがルーティング サービスにアクセスし、ロケーション アロケーションを実行できるようにします。詳細はこちら。 |
| ルート検索 | ルート検索 (経由地の最適化) | premium:user:networkanalysis:optimizedrouting |
アプリケーションがルーティング サービスにアクセスし、最適化されたルート検索処理を実行できるようにします。詳細はこちら。 |
| ルート検索 | 移動コスト マトリックス | premium:user:networkanalysis:origindestinationcostmatrix |
アプリケーションがルーティング サービスにアクセスし、移動コスト マトリックスを生成できるようにします。詳細はこちら。 |
| ルート検索 | 到達圏 | premium:user:networkanalysis:servicearea |
アプリケーションがルーティング サービスにアクセスし、到達圏を生成できるようにします。詳細はこちら。 |
| ルート検索 | 配車ルート解析 | premium:user:networkanalysis:vehiclerouting |
アプリケーションがルーティング サービスにアクセスし、配車ルート解析を実行できるようにします。詳細はこちら。 |
| ルート検索 | ラスト マイル | premium:user:networkanalysis:lastmiledelivery |
アプリケーションがルーティング サービスにアクセスし、ラスト マイル デリバリー解析を実行できるようにします。詳細はこちら。 |
ArcGIS Online アカウントの場合
| カテゴリー | ラベル | 権限の文字列 | 説明 |
|---|---|---|---|
| ベースマップ | ベースマップ スタイル サービス | premium:user:basemaps |
アプリケーションがベースマップ スタイル サービスにアクセスできるようにします。 |
| データ エンリッチメント | ジオエンリッチメント サービス | premium:user:geoenrichment |
アプリケーションがジオエンリッチメント サービスにアクセスできるようにします。詳細はこちら。 |
| ジオコーディング | 住所検索 | premium:user:geocode |
アプリケーションがジオコーディング サービスにアクセスできるようにします。詳細はこちら。 |
| ルート検索 | ルート検索 (ネットワーク解析) | premium:user:networkanalysis |
アプリケーションがルーティング サービスにアクセスできるようにします。詳細はこちら。 |
| ルート検索 | ラスト マイル | premium:user:networkanalysis:lastmiledelivery |
アプリケーションがルーティング サービスにアクセスし、ラスト マイル デリバリー解析を実行できるようにします。詳細はこちら。 |
- アプリケーションに必要な権限を選択し、[次へ] をクリックします。
アイテムの選択 (オプション)
アプリケーションが特定のプライベート アイテムにアクセスする必要がある場合は、開発者の認証情報を設定してアクセスする必要があります。アイテム アクセス メニューでは、ポータルのコンテンツを参照し、キーに特定のアイテムへのきめ細かなアクセスを許可することができます。
- トークンがアイテムへのアクセス権を必要としない場合は、[スキップ] をクリックします。
- [アイテムへのアクセス権を付与] ウィンドウで、[アイテムの参照] をクリックします。
- アクセス権を与えたいアイテムを選択します。このメニューでは最大 100 アイテムまで選択できます。
features:user:edit のような特定の権限は、アカウントに関連するすべてのアイテムへのグローバルアクセスを許可します。このメニューを使用してアイテムへのアクセスを細かく設定すると、設定したグローバル権限が上書きされます。
- [アイテムの追加] をクリックします。
アイテムの保存
API キーの認証情報のプロパティを設定した後、API キーを新しいアイテムとして保存できます。
- [開発者の認証情報を作成] ウィンドウで以下のプロパティを設定し、[次へ] をクリックします。
- タイトル
- フォルダー
- タグ
- サマリー
- [サマリー] ウィンドウで、設定したプロパティ、権限、アイテム アクセスを確認し、[次へ] をクリックします。
API キーのコピー
- [開発者の認証情報を作成] > [API キーの生成] ウィンドウで、[API キーを生成して、アイテム詳細ページに移動します。 キーをコピーして保存する準備ができました。] を選択します。
- [次へ] をクリックします。
- 表示されたウィンドウから API キーをコピーし、アプリケーションに貼り付けます。
APIキーのアクセス トークンの値にアクセスできるのはこの時だけです。再度アクセスすることはできません。新しいキーを取得するには、API キーのアイテムページを使ってキーを再生成する必要があります。
認証情報の管理 (オプション)
API キーのアイテムを作成した後、そのプロパティはアイテム詳細ページに移動していつでも管理できます。設定メニューでは、API キーの以下のプロパティを管理できます。
- セカンダリ API キーの生成 : 同じ認証情報で、同じ権限と新しい有効期限を持つセカンダリ API キーを生成できます。
- API キーの再生成 : API キーにアクセスできなくなった場合、新しい有効期限で再生成することができます。
- API キーの無効化 : API キーを無効にして、アプリケーションで機能しなくすることができます。
- 権限の編集 : API キーの認証レベルを調整するために、API キーの認証情報の権限を編集することができます。
- アイテムのアクセス権を編集 : API キーの認証情報がアクセス許可されているアイテムを編集することができます。
- 使用状況の表示 : API キーの使用状況を監視して、サービスの使用状況を追跡し、請求情報を表示することができます。詳しくは、API key credentials をご覧ください。