Experience Platform API の認証とアクセス

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

Experience Platformおよびユーザーのセキュリティを維持するには、アプリケーション API へのすべてのリクエストが、OAuth などの標準を使用して認証され、承認される必要があります。

このチュートリアルでは、次のフローチャートに概要が示されているように、Platform API 呼び出しを認証するために必要な資格情報を収集する方法について説明します。 必要な資格情報のほとんどは、初期の 1 回限りの設定で収集できます。 ただし、アクセストークンは、24 時間ごとに更新する必要があります。

前提条件 prerequisites

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

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

Experience Platform用の開発者とユーザーアクセスの獲得 gain-developer-user-access

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

開発者アクセスの獲得 gain-developer-access

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

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

ユーザーアクセスの取得 gain-user-access

お使いの Admin Console また、管理者はユーザーを同じ製品プロファイルに追加する必要があります。 ユーザーアクセスを使用すると、UI に、実行する API 操作の結果が表示されます。

次のガイドを参照してください： ユーザーグループの管理 Admin Console を参照してください。

API キー（クライアント ID）と組織 ID の生成 generate-credentials

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

プロジェクトにExperience Platformを追加する add-platform-to-project

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

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

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

OAuth サーバー間認証タイプを選択します。 select-oauth-server-to-server

次に、アクセストークンを生成する認証タイプを選択し、Experience PlatformAPI にアクセスします。

統合する製品プロファイルを選択します。 select-product-profiles

Adobe Analytics の API の設定 画面、選択 AEP-Default-All-Users.

選択 設定済み API を保存 準備が整ったら

Experience PlatformAPI との統合を設定するための上記の手順に関するチュートリアルは、次のビデオチュートリアルでも参照できます。

資格情報の収集 gather-credentials

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

アクセストークンの生成 generate-access-token

次の手順では、 {ACCESS_TOKEN} Platform API 呼び出しで使用する資格情報。 の値とは異なる {API_KEY} および {ORG_ID}に設定する場合、Platform API を使用し続けるには、24 時間ごとに新しいトークンを生成する必要があります。 選択 アクセストークンを生成、以下に示すように。

[非推奨]{class="badge negative"} JSON Web トークン (JWT) を生成 jwt

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}'

{
  "token_type": "bearer",
  "access_token": "{ACCESS_TOKEN}",
  "expires_in": 86399992
}

アクセス資格情報のテスト test-credentials

3 つの必須資格情報（アクセストークン、API キー、組織 ID）をすべて収集したら、次の API 呼び出しをおこないます。 この呼び出しでは、すべての標準 Experience Data Model (XDM) 組織で使用可能なクラス。 で呼び出しを読み込んで実行します。 Postman.

リクエスト

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

必要な属性ベースのアクセス制御権限の取得 get-abac-permissions

Experience Platform内の複数のリソースにアクセスしたり変更したりするには、適切なアクセス制御権限が必要です。 システム管理者から 必要な権限. 詳しくは、 役割用の API 資格情報の管理.

システム管理者が API を使用して Platform リソースにアクセスするために必要な権限を付与する方法に関する詳細については、次のビデオチュートリアルも参照できます。

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

Postman は、開発者が RESTful API を調べてテストできる一般的なツールです。 Experience PlatformPostmanのコレクションおよび環境を使用して、Experience PlatformAPI の操作をスピードアップできます。 詳細を表示： PostmanをExperience Platformで使用 コレクションと環境の概要を参照してください。

PostmanをExperience Platformコレクションおよび環境と共に使用する方法について詳しくは、以下のビデオチュートリアルでも参照できます。

Experience PlatformAPI で使用するPostman環境をダウンロードしてインポートします

Postmanコレクションを使用したアクセストークンの生成

をダウンロードします。 Identity Management Service Postmanコレクション アクセストークンの生成方法については、以下のビデオをご覧ください。

Experience PlatformAPI Postmanコレクションのダウンロードと API の操作

システム管理者：開発者および API のアクセス制御にExperience Platform権限を付与 grant-developer-and-api-access-control

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

製品プロファイルへの開発者の追加 add-developers-to-product-profile

Admin Console に移動し、Adobe ID でログインします。

選択 製品 ​を選択し、「 Adobe Experience Platform を製品のリストから削除します。

次から： 製品プロファイル タブ、選択 AEP-Default-All-Users. または、検索バーを使用して名前を入力し、製品プロファイルを検索します。

を選択します。 開発者 「 」タブで、「 開発者を追加.

開発者の 電子メールまたはユーザー名. 有効な 電子メールまたはユーザー名 開発者の詳細が表示されます。 「保存」を選択します。

開発者が正常に追加され、 開発者 タブをクリックします。

API をロールに割り当て

システム管理者は、システム UI で API をロールに割り当てることができますExperience Platform。

選択 権限 と、API を追加するロールを定義します。 を選択します。 API 資格情報 「 」タブで、「 API 資格情報の追加.

ロールに追加する API を選択し、「 」を選択します。 保存.

次の場所に戻ります。 API 資格情報 タブに追加します。新しく追加された API が表示されます。

その他のリソース additional-resources

Experience PlatformAPI の使用の手引きについては、以下にリンクされている追加のリソースを参照してください。

次の手順 next-steps

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

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