App Builder アクションでのサーバー間アクセストークンの生成
App Builder アクションは、OAuth サーバー間認証情報 をサポートし、App Builder アプリがデプロイされる Adobe Developer Console プロジェクトに関連付けられた Adobe API とやり取りする必要が生じる場合があります。
このガイドでは、App Builder アクションで使用する OAuth サーバー間認証情報 を使用して、アクセストークンを生成する方法について説明します。
Adobe Developer Console プロジェクトの設定
目的の Adobe API を Adobe Developer Console プロジェクトに追加する際、API の設定 手順で、OAuth サーバー間 の認証タイプを選択します。
上記の自動作成された統合サービスアカウントを割り当てるには、目的の製品プロファイルを選択します。したがって、製品プロファイルを介して、サービスアカウントの権限が制御されます。
.env ファイル
App Builder プロジェクトの .env ファイルに、Adobe Developer Console プロジェクトの OAuth サーバー間資格情報のカスタムキーを追加します。OAuth サーバー間資格情報の値は、Adobe Developer Console プロジェクトの 資格情報／OAuth サーバー間 から指定のワークスペースに対して取得できます。
...
OAUTHS2S_CLIENT_ID=58b23182d80a40fea8b12bc236d71167
OAUTHS2S_CLIENT_SECRET=p8e-EIRF6kY6EHLBSdw2b-pLUWKodDqJqSz3
OAUTHS2S_CECREDENTIALS_METASCOPES=AdobeID,openid,ab.manage,additional_info.projectedProductContext,read_organizations,read_profile,account_cluster.read
OAUTHS2S_CLIENT_ID、OAUTHS2S_CLIENT_SECRET、OAUTHS2S_CECREDENTIALS_METASCOPES の値は、Adobe Developer Console プロジェクトの OAuth サーバー間資格情報画面から直接コピーできます。
入力マッピング
.env ファイルにある OAuth サーバー間資格情報の値セットを使用して、アクション自体で読み取ることができるように、それらを AppBuilder アクションの入力にマッピングする必要があります。これを行うには、ext.config.yaml アクション inputs の各変数のエントリを PARAMS_INPUT_NAME: $ENV_KEY の形式で追加します。
次に例を示します。
operations:
view:
- type: web
impl: index.html
actions: actions
runtimeManifest:
packages:
dx-excshell-1:
license: Apache-2.0
actions:
generic:
function: actions/generic/index.js
web: 'yes'
runtime: nodejs:16
inputs:
LOG_LEVEL: debug
OAUTHS2S_CLIENT_ID: $OAUTHS2S_CLIENT_ID
OAUTHS2S_CLIENT_SECRET: $OAUTHS2S_CLIENT_SECRET
OAUTHS2S_CECREDENTIALS_METASCOPES: $OAUTHS2S_CECREDENTIALS_METASCOPES
annotations:
require-adobe-auth: false
final: true
inputs で定義されたキーは、App Builder アクションに提供される params オブジェクトで使用できます。
トークンにアクセスするための OAuth サーバー間資格情報
App Builder のアクションでは、OAuth サーバー間資格情報は params オブジェクトで使用できます。これらの資格情報を使用すると、OAuth 2.0 ライブラリを使用してアクセストークンを生成できます。または、ノード取得ライブラリを使用して、Adobe IMS トークンエンドポイントに POST リクエストを送信して、アクセストークンを取得します。
次の例は、node-fetch ライブラリを使用して、Adobe IMS トークンエンドポイントに POST リクエストを実行し、アクセストークンを取得する方法を示しています。
const fetch = require("node-fetch");
const { Core } = require("@adobe/aio-sdk");
const { errorResponse, stringParameters, checkMissingRequestInputs } = require("../utils");
async function main(params) {
const logger = Core.Logger("main", { level: params.LOG_LEVEL || "info" });
try {
// Perform any necessary input error checking
const systemErrorMessage = checkMissingRequestInputs(params, ["OAUTHS2S_CLIENT_ID", "OAUTHS2S_CLIENT_SECRET", "OAUTHS2S_CECREDENTIALS_METASCOPES"], []);
// The Adobe IMS token endpoint URL
const adobeIMSV3TokenEndpointURL = 'https://ims-na1.adobelogin.com/ims/token/v3';
// The POST request options
const options = {
method: 'POST',
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
},
body: `grant_type=client_credentials&client_id=${params.OAUTHS2S_CLIENT_ID}&client_secret=${params.OAUTHS2S_CLIENT_SECRET}&scope=${params.OAUTHS2S_CECREDENTIALS_METASCOPES}`,
};
// Make a POST request to the Adobe IMS token endpoint to get the access token
const tokenResponse = await fetch(adobeIMSV3TokenEndpointURL, options);
const tokenResponseJSON = await tokenResponse.json();
// The 24-hour IMS Access Token is used to call the AEM Data Service API
// Can look at caching this token for 24 hours to reduce calls
const accessToken = tokenResponseJSON.access_token;
// Invoke an AEM Data Service API using the access token
const aemDataResponse = await fetch(`https://api.adobeaemcloud.com/adobe/stats/statistics/contentRequestsQuota?imsOrgId=${IMS_ORG_ID}¤t=true`, {
headers: {
'X-Adobe-Accept-Experimental': '1',
'x-gw-ims-org-id': IMS_ORG_ID,
'X-Api-Key': params.OAUTHS2S_CLIENT_ID,
Authorization: `Bearer ${access_token}`, // The 24-hour IMS Access Token
},
method: "GET",
});
if (!aemDataResponse.ok) { throw new Error("Request to API failed with status code " + aemDataResponse.status);}
// API data
let data = await aemDataResponse.json();
const response = {
statusCode: 200,
body: data,
};
return response;
} catch (error) {
logger.error(error);
return errorResponse(500, "server error", logger);
}
}
exports.main = main;