App Builder動作可能需要與與Adobe Developer Console專案相關聯的AdobeAPI互動。App Builder應用程式也已部署。
這可能會要求App Builder動作產生與所需Adobe Developer Console專案相關聯的存取權杖。
檢閱 App Builder安全性檔案 以瞭解產生存取權杖與使用所提供的存取權杖的合適時機。
自訂動作可能需要自行提供安全性檢查,以確保只有允許的消費者才能存取App Builder動作及其背後的Adobe服務。
在App Builder專案的 .env
檔案,為每個Adobe Developer主控台專案的JWT憑證附加自訂金鑰。 JWT認證值可從Adobe Developer Console專案的 認證 > 服務帳戶(JWT) 指定工作區的。
...
JWT_CLIENT_ID=58b23182d80a40fea8b12bc236d71167
JWT_CLIENT_SECRET=p8e-EIRF6kY6EHLBSdw2b-pLUWKodDqJqSz3
JWT_TECHNICAL_ACCOUNT_ID=1F072B8A63C6E0230A495EE1@techacct.adobe.com
JWT_IMS_ORG=7ABB3E6A5A7491460A495D61@AdobeOrg
JWT_METASCOPES=https://ims-na1.adobelogin.com/s/ent_analytics_bulk_ingest_sdk,https://ims-na1.adobelogin.com/s/event_receiver_api
JWT_PRIVATE_KEY=LS0tLS1C..kQgUFJJVkFURSBLRVktLS0tLQ==
以下專案的值: JWT_CLIENT_ID
, JWT_CLIENT_SECRET
, JWT_TECHNICAL_ACCOUNT_ID
, JWT_IMS_ORG
可以從Adobe Developer主控台專案的JWT憑證畫面直接複製。
決定App Builder動作與互動的AdobeAPI及其中繼資料。 在中以逗號分隔符號列出Metascope JWT_METASCOPES
金鑰。 有效的中繼資料集會列在 Adobe的JWT Metascope檔案.
例如,可將下列值新增至 JWT_METASCOPES
中的索引鍵 .env
:
...
JWT_METASCOPES=https://ims-na1.adobelogin.com/s/ent_analytics_bulk_ingest_sdk,https://ims-na1.adobelogin.com/s/event_receiver_api
...
此 JWT_PRIVATE_KEY
必須是特別格式化,因為它原本就是多行值,在中不受支援 .env
檔案。 最簡單的方式是以base64編碼私密金鑰。 私密金鑰的Base64編碼(-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----
)可使用作業系統提供的原生工具來完成。
開啟 Terminal
執行命令 base64 -i /path/to/private.key | pbcopy
系統會自動將base64輸出複製到剪貼簿
貼入 .env
作為對應索引鍵的值
開啟 Command Prompt
執行命令 certutil -encode C:\path\to\private.key C:\path\to\encoded-private.key
執行命令 findstr /v CERTIFICATE C:\path\to\encoded-private.key
將base64輸出複製到剪貼簿
貼入 .env
作為對應索引鍵的值
開啟終端機
執行命令 base64 private.key
將base64輸出複製到剪貼簿
貼入 .env
作為對應索引鍵的值
例如,可以將下列base64編碼的私密金鑰新增至 JWT_PRIVATE_KEY
中的索引鍵 .env
:
...
JWT_PRIVATE_KEY=LS0tLS1C..kQgUFJJVkFURSBLRVktLS0tLQ==
在JWT認證值設定於 .env
檔案中,必須將其對應至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
JWT_CLIENT_ID: $JWT_CLIENT_ID
JWT_TECHNICAL_ACCOUNT_ID: $JWT_TECHNICAL_ACCOUNT_ID
JWT_IMS_ORG: $JWT_IMS_ORG
JWT_METASCOPES: $JWT_METASCOPES
JWT_PRIVATE_KEY: $JWT_PRIVATE_KEY
annotations:
require-adobe-auth: false
final: true
下定義的索引鍵 inputs
可在以下網址取得: params
提供給App Builder動作的物件。
在App Builder動作中, JWT認證位於 params
物件,使用者: @adobe/jwt-auth
以產生存取Token,存取Token可存取其他AdobeAPI和服務。
const fetch = require("node-fetch");
const { Core } = require("@adobe/aio-sdk");
const { errorResponse, stringParameters, checkMissingRequestInputs } = require("../utils");
const auth = require("@adobe/jwt-auth");
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, [
"JWT_CLIENT_ID", "JWT_TECHNICAL_ACCOUNT_ID", "JWT_IMS_ORG", "JWT_CLIENT_SECRET", "JWT_METASCOPES", "JWT_PRIVATE_KEY"], []);
// Split the metascopes into an array (they are comma delimited in the .env file)
const metascopes = params.JWT_METASCOPES?.split(',') || [];
// Base64 decode the private key value
const privateKey = Buffer.from(params.JWT_PRIVATE_KEY, 'base64').toString('utf-8');
// Exchange the JWT credentials for an 24-hour Access Token
let { accessToken } = await auth({
clientId: params.JWT_CLIENT_ID, // Client Id
technicalAccountId: params.JWT_TECHNICAL_ACCOUNT_ID, // Technical Account Id
orgId: params.JWT_IMS_ORG, // Adobe IMS Org Id
clientSecret: params.JWT_CLIENT_SECRET, // Client Secret
metaScopes: metascopes, // Metadcopes defining level of access the access token should provide
privateKey: privateKey, // Private Key to sign the JWT
});
// The 24-hour IMS Access Token is used to call the Analytics APIs
// Can look at caching this token for 24 hours to reduce calls
const accessToken = await getAccessToken(params);
// Invoke an exmaple Adobe API endpoint using the generated accessToken
const res = await fetch('https://analytics.adobe.io/api/example/reports', {
headers: {
"Accept": "application/json",
"Content-Type": "application/json",
"X-Proxy-Global-Company-Id": 'example',
"Authorization": `Bearer ${accessToken}`,
"x-Api-Key": params.JWT_CLIENT_ID,
},
method: "POST",
body: JSON.stringify({... An Analytics query ... }),
});
if (!res.ok) { throw new Error("Request to API failed with status code " + res.status);}
// Analytics API data
let data = await res.json();
const response = {
statusCode: 200,
body: data,
};
return response;
} catch (error) {
logger.error(error);
return errorResponse(500, "server error", logger);
}
}
exports.main = main;