Experience Platform API の認証とアクセス

このドキュメントでは、Experience Platform API を呼び出すために Adobe Experience Platform 開発者アカウントにアクセスするための順を追ったチュートリアルを提供します。このチュートリアルの最後に、すべての Platform API 呼び出しに必要な次の資格情報が生成されます。

  • {ACCESS_TOKEN}
  • {API_KEY}
  • {ORG_ID}

アプリケーションとユーザーのセキュリティを維持するには、Adobe I/O API へのすべてのリクエストが、OAuth や JSON Web Tokens(JWT)などの標準を使用して認証され、承認される必要があります。JWT は、個人用アクセストークンを生成するために、クライアント固有の情報と共に使用されます。

このチュートリアルでは、次のフローチャートに示すように、Platform API 呼び出しを認証するために必要な資格情報を収集する方法について説明します。

前提条件

Experience PlatformAPI を正しく呼び出すには、次が必要です。

  • Adobe Experience Platform へのアクセス権を持つ IMS 組織.
  • Admin Consoleプロファイルの開発者およびユーザーとして追加できる製品管理者。

また、このチュートリアルを完了するには、Adobe IDが必要です。 Adobe ID をお持ちでない場合は、次の手順で作成できます。

  1. に移動します。 Adobe開発者コンソール.
  2. 選択 新しいアカウントを作成.
  3. サインアッププロセスを完了します。

Experience Platform用の開発者とユーザーアクセスの獲得

Adobe Developer Console で統合を作成する前に、Adobe Admin ConsoleのExperience Platform製品プロファイルに対する開発者権限とユーザー権限を持つアカウントが必要です。

開発者アクセスの獲得

連絡先: Admin Console 組織の管理者に問い合わせて、 Admin Console. 詳しくは、 Admin Console 方法に関する具体的な手順に関するドキュメント 製品プロファイルの開発者アクセスの管理.

開発者として割り当てられたら、で統合の作成を開始できます。 Adobe開発者コンソール. これらの統合は、外部のアプリやサービスからAdobeAPI へのパイプラインです。

ユーザーアクセスの取得

お使いの Admin Console また、管理者はユーザーを同じ製品プロファイルに追加する必要があります。 詳しくは、 ユーザーグループの管理 Admin Console を参照してください。

API キー、IMS Org ID およびクライアントの秘密鍵を生成します

メモ

このドキュメントを Privacy ServiceAPI ガイドに戻り、固有のアクセス資格情報を生成できるようになりました。 Privacy Service.

を通じて Platform への開発者およびユーザーアクセス権を付与されたら、 Admin Console次の手順は、 {ORG_ID} および {API_KEY} Adobe開発者コンソールの資格情報。 これらの資格情報は 1 回だけ生成する必要があり、今後の Platform API 呼び出しで再利用できます。

プロジェクトにExperience Platformを追加する

Adobe Developer Console に移動し 、Adobe ID を使用してログインします。次に、Adobe Developer Console のドキュメントの空のプロジェクトの作成チュートリアルで概説されている手順に従います。

新しいプロジェクトを作成したら、「 API を追加プロジェクトの概要 画面

API の追加​画面が表示されます。 Adobe Experience Platformの製品アイコンを選択し、「 Experience PlatformAPI 選択する前に 次へ.

ここから、 サービスアカウント (JWT) を使用したプロジェクトへの API の追加 (「API の設定」手順から開始)を実行して、プロセスを完了します。

重要

上記にリンクされたプロセス中の特定の手順で、ブラウザーは、秘密鍵と関連する公開証明書を自動的にダウンロードします。 この秘密鍵は、このチュートリアルの後の手順で必要になるので、お使いのコンピューター上のどこに保存されるかをメモしておきます。

資格情報の収集

API がプロジェクトに追加されると、 Experience PlatformAPI プロジェクトのページには、Experience PlatformAPI へのすべての呼び出しで必要な次の資格情報が表示されます。

  • {API_KEY} (クライアント ID)
  • {ORG_ID} (Organization ID)

上記の資格情報に加えて、生成された クライアント秘密鍵 を参照してください。 選択 クライアント秘密鍵を取得 をクリックして値を表示し、後で使用するためにコピーします。

JSON Web トークン (JWT) の生成

次の手順では、アカウントの資格情報に基づいて JSON Web トークン (JWT) を生成します。 この値は、 {ACCESS_TOKEN} Platform API 呼び出しで使用する資格情報。24 時間ごとに再生成する必要があります。

重要

このチュートリアルの目的上、以下の手順では、開発者コンソール内で JWT を生成する方法の概要を説明します。 ただし、この生成方法は、テストおよび評価の目的でのみ使用する必要があります。

通常の使用では、JWT を自動的に生成する必要があります。 プログラムによる JWT の生成方法について詳しくは、 サービスアカウント認証ガイド Adobe Developer

選択 サービスアカウント (JWT) 左側のナビゲーションで、「 JWT を生成.

の下に表示されるテキストボックス内 カスタム JWT を生成、Platform API をサービスアカウントに追加する際に以前生成した秘密鍵の内容を貼り付けます。 次に、 トークンを生成.

ページが更新され、生成された JWT が表示されます。また、アクセストークンを生成できるサンプルの cURL コマンドも表示されます。 このチュートリアルの目的で、 コピー 次の 生成された JWT をクリックして、トークンをクリップボードにコピーします。

アクセストークンの生成

JWT を生成したら、API 呼び出しで使用して、 {ACCESS_TOKEN}. の値とは異なる {API_KEY} および {ORG_ID}に設定する場合、Platform API を使用し続けるには、24 時間ごとに新しいトークンを生成する必要があります。

リクエスト

次のリクエストでは、新しい {ACCESS_TOKEN} ペイロードで指定された資格情報に基づきます。 このエンドポイントは、フォームデータをペイロードとしてのみ受け入れるので、 Content-Type ヘッダー multipart/form-data.

curl -X POST https://ims-na1.adobelogin.com/ims/exchange/jwt \
  -H 'Content-Type: multipart/form-data' \
  -F 'client_id={API_KEY}' \
  -F 'client_secret={SECRET}' \
  -F 'jwt_token={JWT}'
プロパティ 説明
{API_KEY} この {API_KEY} (クライアント ID) 前の手順.
{SECRET} で取得したクライアント秘密鍵 前の手順.
{JWT} で生成した JWT 前の手順.
メモ

同じ API キー、クライアントの秘密鍵、JWT を使用して、各セッションに対して新しいアクセストークンを生成できます。 これにより、アプリケーションでのアクセストークンの生成を自動化できます。

応答

{
  "token_type": "bearer",
  "access_token": "{ACCESS_TOKEN}",
  "expires_in": 86399992
}
プロパティ 説明
token_type 返されるトークンのタイプ。 アクセストークンの場合、この値は常に bearer.
access_token 生成された {ACCESS_TOKEN}. この値の先頭には、「 Bearerは、 Authentication すべての Platform API 呼び出し用のヘッダー。
expires_in アクセストークンの有効期限が切れるまでの残り時間(ミリ秒)。 この値が 0 に達したら、Platform API を使用し続けるには、新しいアクセストークンを生成する必要があります。

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

3 つの必要な資格情報をすべて収集したら、次の API 呼び出しをおこないます。 この呼び出しでは、すべての標準 Experience Data Model (XDM) 組織で使用可能なクラス。

リクエスト

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: {ORG_ID}'

応答

応答が次に示すような場合は、資格情報が有効で機能しています。 (スペース節約のために応答は部分的に表示されています。)

{
  "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"
    }
  ]
}

Postmanを使用した API 呼び出しの認証とテスト

Postman は、開発者が RESTful API を調べてテストできる一般的なツールです。 この 投稿(中) JWT 認証を自動的に実行し、それを使用して Platform API を使用するようにPostmanを設定する方法について説明します。

次の手順

このドキュメントでは、Platform API のアクセス資格情報を収集し、正常にテストしました。 これで、 ドキュメント.

このチュートリアルで収集した認証値に加えて、多くの Platform API では有効な {SANDBOX_NAME} ヘッダーとして提供される。 詳しくは、「サンドボックスの概要」を参照してください。

このページ