Show Menu
トピック×

Experience Platform APIの認証とアクセス

このドキュメントでは、Experience Platform APIを呼び出すためのAdobe Experience Platform開発者アカウントへのアクセス権を取得するための、手順を追ったチュートリアルを提供します。

API呼び出しを行うための認証

アプリケーションとユーザーのセキュリティを維持するには、Adobe I/O APIへのすべての要求が、OAuthやJSON Web Tokens(JWT)などの標準を使用して認証され、承認される必要があります。 次に、JWTをクライアント固有の情報と共に使用して個人アクセストークンを生成します。
このチュートリアルでは、次のフローチャートで概要を説明するアクセストークンを作成する際の認証手順について説明します。

前提条件

Experience Platform APIの呼び出しを正常に行うには、次の情報が必要です。
  • Adobe Experience Platformへのアクセス権を持つIMS組織
  • 登録済みのAdobe IDアカウント
  • 開発者 および製品の ユーザーとして追加する管理コンソール管理者 ​。
以下の各節では、Adobe IDを作成し、組織の開発者およびユーザーになる手順について説明します。

Adobe IDの作成

Adobe IDをお持ちでない場合は、次の手順で作成できます。
  1. Adobe Developer Console に移動
  2. 「新規アカウントを 作成」をクリックします
  3. 入会プロセスの完了

組織のエクスペリエンスプラットフォーム開発者とユーザーになる

Adobe I/Oで統合を作成する前に、IMS組織の製品に対する開発者権限をアカウントに持っている必要があります。 管理コンソールの開発者アカウントに関する詳細は、開発者管理の サポートドキュメント を参照してください。
開発者アクセスの取得
先に進むには、管理者が開発者として少なくとも1つの製品プロファイルに割り当てる必要があります。
開発者として割り当てられたら、 Adobe I/O上で統合を作成するためのアクセス権が与えられます 。 これらの統合は、外部のアプリケーションやサービスからAdobe APIへのパイプラインとなります。
ユーザーアクセスの取得
また、管理コンソール管理者がユーザを製品に追加する必要があります。
開発者を追加するプロセスと同様に、先に進むには、管理者が少なくとも1つの製品プロファイルを割り当てる必要があります。

Adobe Developer Consoleでのアクセス資格情報の生成

Adobe Developer Consoleを使用して、次の3つのアクセス資格情報を生成する必要があります。
  • {IMS_ORG}
  • {API_KEY}
  • {ACCESS_TOKEN}
およ {IMS_ORG}``{API_KEY} びは1回だけ生成する必要があり、今後のプラットフォームAPI呼び出しで再利用できます。 ただし、一時的な {ACCESS_TOKEN} ので、24時間ごとに再生成する必要があります。
手順の詳細は以下のとおりです。

1回限りのセットアップ

Adobe Developer Console に移動し 、Adobe IDでサインインします。 次に、Adobe Developer Consoleドキュメントで空のプロジェクトの 作成に関するチュートリアルに概要を説明している手順に従い ます。
新しいプロジェクトを作成したら、プ ロジェクト概要 画面の「 API 」をクリックします。
API __ 追加画面が表示されます。 Adobe Experience Platformの製品アイコンをクリックし、「 次へ 」をクリックする前に「 Experience Platform API 」を選択します。
プロジェクトに追加するAPIとしてエクスペリエンスプラットフォームを選択したら、サービスアカウント(JWT)を使用したプロジェクトへのAPIの 追加(「APIを設定」の手順から開始)のチュートリアルに従って 、プロセスを完了します。
APIがプロジェクトに追加されると、 プロジェクトの概要 ページに、Experience Platform APIへのすべての呼び出しで必要な以下の資格情報が表示されます。
  • {API_KEY} (クライアントID)
  • {IMS_ORG} (Organization ID)

各セッションの認証

最後に必要な秘密鍵証明書は、収集する必要がある秘密鍵証明書 {ACCESS_TOKEN} です。 との値とは異なり、新しいトークン {API_KEY}``{IMS_ORG} は24時間ごとに生成し、プラットフォームAPIを引き続き使用する必要があります。
新しいトークンを生成するに {ACCESS_TOKEN} は、『Developer Console credentials』ガイドのJWTトークンを 生成する手順に従います

アクセス資格情報のテスト

3つの必要な資格情報をすべて収集したら、以下のAPI呼び出しを行うことができます。 この呼び出しは、スキーマレジストリの global コンテナ内のすべてのExperience Data Model(XDM)クラスをリストします。
API形式
GET /global/classes

リクエスト
curl -X GET https://platform.adobe.io/data/foundation/schemaregistry/global/classes \
  -H 'Accept: application/vnd.adobe.xed-id+json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}'

応答
応答が以下に示す応答と類似している場合は、資格情報が有効で、機能しています。 (この応答は領域のために切り捨てられました。)
{
  "results": [
    {
        "title": "XDM ExperienceEvent",
        "$id": "https://ns.adobe.com/xdm/context/experienceevent",
        "meta:altId": "_xdm.context.experienceevent",
        "version": "1"
    },
    {
        "title": "XDM Individual Profile",
        "$id": "https://ns.adobe.com/xdm/context/profile",
        "meta:altId": "_xdm.context.profile",
        "version": "1"
    }
  ]
}

JWT認証およびAPI呼び出しにPostmanを使用

Postman は、RESTful APIを操作するための一般的なツールです。 この Medium post (中)では、JWT認証を自動的に実行するようにpostmanを設定し、それをAdobe Experience Platform APIを使用する方法について説明します。

次の手順

このドキュメントを読むと、Platform APIのアクセス資格情報を収集し、正常にテストすることができます。 ドキュメント全体で提供されているAPI呼び出しの例に従うことができ ます
このチュートリアルで収集した認証値に加えて、多くのプラットフォームAPIでは、有効な認証値をヘッダーとして指定す {SANDBOX_NAME} る必要があります。 See the sandboxes overview for more information.