Gerar token de acesso JWT na ação do App Builder
As ações do App Builder podem precisar interagir com APIs de Adobe associadas a projetos do Adobe Developer Console nos quais o aplicativo App Builder é implantado.
Isso pode exigir que a ação do App Builder gere seu próprio token de acesso JWT associado ao projeto do Adobe Developer Console desejado.
arquivo .env
No arquivo .env
do projeto do App Builder, anexe chaves personalizadas para cada credencial JWT do projeto do Adobe Developer Console. Os valores da credencial JWT podem ser obtidos das Credenciais > Conta de Serviço (JWT) do projeto do Adobe Developer Console para um determinado espaço de trabalho.
...
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==
Os valores de JWT_CLIENT_ID
, JWT_CLIENT_SECRET
, JWT_TECHNICAL_ACCOUNT_ID
, JWT_IMS_ORG
podem ser copiados diretamente da tela Credenciais JWT do projeto do Adobe Developer Console.
Metascópios
Determine as APIs de Adobe e seus metascópios com os quais a ação do App Builder interage. Listar metascópios com vírgulas como delimitadores na chave JWT_METASCOPES
. Os metascópios válidos estão listados em Documentação do Metascope JWT do Adobe.
Por exemplo, o seguinte valor pode ser adicionado à chave JWT_METASCOPES
em .env
:
...
JWT_METASCOPES=https://ims-na1.adobelogin.com/s/ent_analytics_bulk_ingest_sdk,https://ims-na1.adobelogin.com/s/event_receiver_api
...
Chave privada
O JWT_PRIVATE_KEY
deve ser especialmente formatado, pois é nativamente um valor de várias linhas, o que não é suportado em arquivos .env
. A maneira mais fácil é codificar a chave privada em base64. A codificação Base64 da chave privada (-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----
) pode ser feita usando ferramentas nativas fornecidas pelo seu sistema operacional.
-
Abrir
Terminal
-
Executar o comando
base64 -i /path/to/private.key | pbcopy
-
A saída base64 é copiada automaticamente para a área de transferência
-
Colar em
.env
como valor para a chave correspondente
-
Abrir
Command Prompt
-
Executar o comando
certutil -encode C:\path\to\private.key C:\path\to\encoded-private.key
-
Executar o comando
findstr /v CERTIFICATE C:\path\to\encoded-private.key
-
Copie a saída base64 para a área de transferência
-
Colar em
.env
como valor para a chave correspondente
-
Abrir terminal
-
Executar o comando
base64 private.key
-
Copie a saída base64 para a área de transferência
-
Colar em
.env
como valor para a chave correspondente
Por exemplo, a seguinte chave privada codificada em base64 pode ser adicionada à chave JWT_PRIVATE_KEY
em .env
:
...
JWT_PRIVATE_KEY=LS0tLS1C..kQgUFJJVkFURSBLRVktLS0tLQ==
Mapeamento de entradas
Com o valor da credencial JWT definido no arquivo .env
, ele deve ser mapeado para as entradas de ação do AppBuilder para que possa ser lido na própria ação. Para fazer isso, adicione entradas para cada variável na ação ext.config.yaml
inputs
no formato: PARAMS_INPUT_NAME: $ENV_KEY
.
Por exemplo:
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
As chaves definidas em inputs
estão disponíveis no objeto params
fornecido para a ação App Builder.
Credenciais JWT para acessar o token
Na ação do App Builder, as credenciais JWT estão disponíveis no objeto params
e podem ser usadas por @adobe/jwt-auth
para gerar um token de acesso, que por sua vez pode acessar outras APIs e serviços do Adobe.
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;