Experience Platform API の認証とアクセス

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

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

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

前提条件 prerequisites

Experience PlatformAPI を正常に呼び出すには、次の条件を満たす必要があります。

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

Experience Platformのための開発者およびユーザーのアクセス権の取得 gain-developer-user-access

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

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

に連絡 Admin Console を使用してExperience Platform製品プロファイルに開発者として追加する組織内の管理者 Admin Console. を参照してください。 Admin Console 方法の具体的な手順に関するドキュメント 製品プロファイルの開発者アクセスの管理.

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

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

あなたの Admin Console 管理者は、ユーザーとしても同じ製品プロファイルに追加できる必要があります。 ユーザーアクセスを使用すると、実行する API 操作の結果を UI で確認できます。

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

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

以下を通じて開発者およびユーザーに Platform へのアクセス権を付与した後 Admin Console次の手順では、を生成します。 {ORG_ID} および {API_KEY} Adobe Developer コンソールの資格情報。 これらの資格情報は 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

次に、 OAuth サーバー間 アクセストークンを生成して認証 API にアクセスするためのExperience Platformタイプ。

統合用の製品プロファイルの選択 select-product-profiles

が含まれる API の設定 画面、選択 AEP-Default-All-Users.

を選択 設定済み API を保存 準備ができたら。

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

資格情報の収集 gather-credentials

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

アクセストークンの生成 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

アクセストークン、API キー、組織 ID の 3 つの必要な資格情報をすべて収集したら、次の 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 PlatformのPostman コレクションおよび環境を使用して、Experience PlatformAPI の作業を高速化できます。 詳細を読む： Experience PlatformでのPostmanの使用 コレクションと環境の基本を学ぶ

Experience Platformコレクションおよび環境でのPostmanの使用について詳しくは、以下のビデオチュートリアルも参照してください。

Experience PlatformAPI で使用するPostman環境をダウンロードして読み込む

Postman コレクションを使用してアクセストークンを生成します

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

Experience PlatformAPI Postman コレクションをダウンロードし、API とやり取りする

システム管理者：Experience Platform権限を使用して開発者と API のアクセス制御を付与します grant-developer-and-api-access-control

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

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

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

を選択 製品 ​を選択してから、 Adobe Experience Platform 製品のリストから。

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

「」を選択します 開発者 tab キーを押してから、 開発者を追加.

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

開発者が正常に追加され、に表示されます 開発者 タブ。

API を役割に割り当てる

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

を選択 権限 および API を追加する役割。 「」を選択します API 資格情報 tab キーを押してから、 API 資格情報の追加.

役割に追加する API を選択して、を選択します。 保存.

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

その他のリソース additional-resources

Experience PlatformAPI の概要の詳細については、以下にリンクされているその他のリソースを参照してください

次の手順 next-steps

このドキュメントでは、Platform API のアクセス資格情報を収集し、正常にテストしました。 全体で提供される API 呼び出しの例に従うことができるようになりました 詳細を見る.

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