ガイドAPIリファレンス
ガイド

APIおよびOAuthアクセスを管理する

OAuthは、APIベースの認証よりも柔軟性とセキュリティが高く、HEREプラットフォームで新しいアプリを作成する際によく使用される認証方式です。このトピックでは、APIベースの認証からOAuthベースの認証に移行する方法について説明します。

OAuth用のアプリ設定の詳細については、「OAuth 2.0トークン」を参照してください。

アプリが正しいトークンを使用していることを確認する

OAuthトークンは、ベアラートークンとして認証ヘッダーに渡されます。HERE REST APIを呼び出せるよう、アプリケーションを更新してヘッダーにトークンを含めてください。

-H "Authorization: Bearer {YOUR_TOKEN}"

詳細については、以下を参照してください。

アプリのスコープ権限を設定する

移行時には、レルム内のアプリに提供する具体的なスコープを決定する必要があります。これらのスコープによって、アプリがアクセス可能なプロジェクトやリソースが決まります。プロジェクトにリンクされたリソースには、そのプロジェクトのスコープを持つアプリのみがアクセスできます。

一方、スコープ外のプロジェクトやリソースにアクセスするには、スコープ外のアクセストークンが必要です。スコープ外のアクセストークンをリクエストするには、scopeパラメーターを使用せずにアクセストークンを生成してください。

アプリのスコープ管理の詳細については、次を参照してください。

トークンの有効期間をユーザーに通知する

セキュリティ上の理由から、OAuthアクセストークンには有効期間があります。アクセストークンのデフォルトの最大有効期間は24時間です。ただし、このデフォルト値は、トークン作成時にexpiresInプロパティを使用して変更できます。

OAuthリフレッシュトークンを作成する際、有効期限はトークン作成後に確認できます。

{
    "accessToken": "eyJhbGciOiJSUz...omKF5Mg-sBjryw",
    "expiresAt": "2025-01-01T16:16:14.388Z"
}

詳細については、APIトークンの「HERE OLP CLIユーザーガイド」を参照してください。

ソース管理からAPIキーを削除する

アプリをテストする際、誤ってAPIキーをバージョン管理システムに保存されているファイルに含めてしまう可能性があります。これは、APIキーが完全に廃止されるまでセキュリティ上の問題を引き起こす可能性があります。

移行プロセスの一環として、バージョン管理システムを確認し、APIキーを含むコミットやアーティファクトをすべて削除してください。