Token di accesso per lo sviluppo locale

Gli sviluppatori che creano integrazioni che richiedono l’accesso programmatico ad AEM as a Cloud Service hanno bisogno di un modo semplice e rapido per ottenere token di accesso temporaneo per AEM al fine di facilitare le attività di sviluppo locali. Per soddisfare questa esigenza, la Console per sviluppatori di AEM consente agli sviluppatori di generare automaticamente token di accesso temporaneo che possono essere utilizzati per accedere a AEM a livello di programmazione.

Generare un token di accesso allo sviluppo locale

Ottenere un token di accesso allo sviluppo locale

Il token di accesso allo sviluppo locale fornisce l’accesso ai servizi Author e Publish di AEM come utente che ha generato il token, insieme alle relative autorizzazioni. Sebbene si tratti di un token di sviluppo, non condividere il token o archiviare nel controllo del codice sorgente.

  1. In Adobe AdminConsole assicurati, lo sviluppatore, di essere membro di:
    • Cloud Manager - Profilo di prodotto Developer IMS (consente l’accesso ad AEM Developer Console)
    • Il profilo di prodotto Amministratori AEM o Utenti AEM IMS per il servizio dell’ambiente AEM con cui il token di accesso si integra
    • Gli ambienti AEM as a Cloud Service sandbox richiedono l’iscrizione solo nel profilo di prodotto Amministratori AEM o Utenti AEM
  2. Accedi a Adobe Cloud Manager
  3. Apri il programma contenente l’ambiente AEM as a Cloud Service con cui eseguire l’integrazione
  4. Tocca i puntini di sospensione accanto all’ambiente nella sezione Ambienti e seleziona Console per sviluppatori
  5. Tocca la scheda Integrazioni .
  6. Tocca il pulsante Ottieni token di sviluppo locale
  7. Tocca il pulsante di download nell’angolo in alto a sinistra per scaricare il file JSON contenente il valore accessToken e salvare il file JSON in una posizione sicura sul computer di sviluppo.
    • Token di accesso per sviluppatori per 24 ore nell’ambiente AEM as a Cloud Service.

AEM Developer Console - Integrazioni - Ottieni token di sviluppo locale

Utilizzato il token di accesso allo sviluppo locale

Token di accesso allo sviluppo locale - Applicazione esterna

  1. Scarica il token di accesso locale temporaneo da AEM Developer Console
    • Il token di accesso allo sviluppo locale scade ogni 24 ore, pertanto gli sviluppatori dovranno scaricare quotidianamente nuovi token di accesso
  2. È in corso lo sviluppo di un’applicazione esterna che interagisce programmaticamente con AEM as a Cloud Service
  3. L'applicazione esterna viene letta nel token di accesso allo sviluppo locale
  4. L’applicazione esterna crea richieste HTTP ad AEM as a Cloud Service, aggiungendo il Token di accesso allo sviluppo locale come token portatore all’intestazione Autorizzazione delle richieste HTTP
  5. AEM as a Cloud Service riceve la richiesta HTTP, autentica la richiesta ed esegue il lavoro richiesto dalla richiesta HTTP e restituisce una risposta HTTP all’applicazione esterna

Applicazione esterna di esempio

Verrà creata una semplice applicazione JavaScript esterna per illustrare come accedere in modo programmatico ad AEM as a Cloud Service tramite HTTPS utilizzando il token di accesso per sviluppatori locale. Questo illustra come qualsiasi applicazione o sistema in esecuzione al di fuori di AEM, indipendentemente dal framework o dalla lingua, può utilizzare il token di accesso per l’autenticazione e l’accesso programmatici ad AEM as a Cloud Service. Nella sezione successiva aggiorneremo questo codice dell'applicazione per supportare l'approccio per la generazione di un token per l'uso in produzione.

Questa applicazione di esempio viene eseguita dalla riga di comando e aggiorna i metadati delle risorse AEM utilizzando le API HTTP di AEM Assets, utilizzando il seguente flusso:

  1. Legge i parametri dalla riga di comando (getCommandLineParams())
  2. Ottiene il token di accesso utilizzato per l’autenticazione in AEM as a Cloud Service (getAccessToken(...))
  3. Elenca tutte le risorse in una cartella di risorse AEM specificata in un parametro della riga di comando (listAssetsByFolder(...))
  4. Aggiorna i metadati delle risorse elencate con i valori specificati nei parametri della riga di comando (updateMetadata(...))

L’elemento chiave per l’autenticazione programmatica ad AEM tramite il token di accesso è l’aggiunta di un’intestazione di richiesta di autorizzazione HTTP a tutte le richieste HTTP effettuate ad AEM, nel seguente formato:

  • Authorization: Bearer ACCESS_TOKEN

Esecuzione dell'applicazione esterna

  1. Assicurati che Node.js sia installato nel computer di sviluppo locale, che verrà utilizzato per eseguire l'applicazione esterna

  2. Scarica e decomprimi il campione dell'applicazione esterna

  3. Dalla riga di comando, nella cartella di questo progetto, esegui npm install

  4. Copia il scaricato dal token di accesso allo sviluppo locale in un file denominato local_development_token.json nella directory principale del progetto

    • Ma ricorda, non impegnare mai nessuna creatività a Git!
  5. Apri index.js e controlla il codice dell'applicazione esterna e i commenti.

    const fetch = require('node-fetch');
    const fs = require('fs');
    const auth = require('@adobe/jwt-auth');
    
    // The root context of the Assets HTTP API
    const ASSETS_HTTP_API = '/api/assets';
    
    // Command line parameters
    let params = { };
    
    /**
    * Application entry point function
    */
    (async () => {
        console.log('Example usage: node index.js aem=https://author-p1234-e5678.adobeaemcloud.com propertyName=metadata/dc:rights "propertyValue=WKND Limited Use" folder=/wknd/en/adventures/napa-wine-tasting file=credentials-file.json' );
    
        // Parse the command line parameters
        params = getCommandLineParams();
    
        // Set the access token to be used in the HTTP requests to be local development access token
        params.accessToken = await getAccessToken(params.developerConsoleCredentials);
    
        // Get a list of all the assets in the specified assets folder
        let assets = await listAssetsByFolder(params.folder);
    
        // For each asset, update it's metadata
        await assets.forEach(asset => updateMetadata(asset, { 
            [params.propertyName]: params.propertyValue 
        }));
    })();
    
    /**
    * Returns a list of Assets HTTP API asset URLs that reference the assets in the specified folder.
    * 
    * https://experienceleague.adobe.com/docs/experience-manager-cloud-service/assets/admin/mac-api-assets.html?lang=it#retrieve-a-folder-listing
    * 
    * @param {*} folder the Assets HTTP API folder path (less the /content/dam path prefix)
    */
    async function listAssetsByFolder(folder) {
        return fetch(`${params.aem}${ASSETS_HTTP_API}${folder}.json`, {
                method: 'get',
                headers: { 
                    'Content-Type': 'application/json',
                    'Authorization': 'Bearer ' + params.accessToken // Provide the AEM access token in the Authorization header
                },
            })
            .then(res => {
                console.log(`${res.status} - ${res.statusText} @ ${params.aem}${ASSETS_HTTP_API}${folder}.json`);
    
                // If success, return the JSON listing assets, otherwise return empty results
                return res.status === 200 ? res.json() : { entities: [] };
            })
            .then(json => { 
                // Returns a list of all URIs for each non-content fragment asset in the folder
                return json.entities
                    .filter((entity) => entity['class'].indexOf('asset/asset') === -1 && !entity.properties.contentFragment)
                    .map(asset => asset.links.find(link => link.rel.find(r => r === 'self')).href);
            });
    }
    
    /**
    * Update the metadata of an asset in AEM
    * 
    * https://experienceleague.adobe.com/docs/experience-manager-cloud-service/assets/admin/mac-api-assets.html?lang=it#update-asset-metadata
    * 
    * @param {*} asset the Assets HTTP API asset URL to update
    * @param {*} metadata the metadata to update the asset with
    */
    async function updateMetadata(asset, metadata) {        
        await fetch(`${asset}`, {
                method: 'put',
                headers: { 
                    'Content-Type': 'application/json',
                    'Authorization': 'Bearer ' + params.accessToken // Provide the AEM access token in the Authorization header
                },
                body: JSON.stringify({
                    class: 'asset',
                    properties: metadata
                })
            })
            .then(res => { 
                console.log(`${res.status} - ${res.statusText} @ ${asset}`);
            });
    }
    
    /**
    * Parse and return the command line parameters. Expected params are:
    * 
    * - aem = The AEM as a Cloud Service hostname to connect to.
    *              Example: https://author-p12345-e67890.adobeaemcloud.com
    * - folder = The asset folder to update assets in. Note that the Assets HTTP API do NOT use the JCR `/content/dam` path prefix.
    *              Example: '/wknd/en/adventures/napa-wine-tasting'
    * - propertyName = The asset property name to update. Note this is relative to the [dam:Asset]/jcr:content node of the asset.
    *              Example: metadata/dc:rights
    * - propertyValue = The value to update the asset property (specified by propertyName) with.
    *              Example: "WKND Free Use"
    * - file = The path to the JSON file that contains the credentials downloaded from AEM Developer Console
    *              Example: local_development_token_cm_p1234-e5678.json 
    */
    function getCommandLineParams() {
        let parameters = {};
    
        // Parse the command line params, splitting on the = delimiter
        for (let i = 2; i < process.argv.length; i++) {
            let key = process.argv[i].split('=')[0];
            let value = process.argv[i].split('=')[1];
    
            parameters[key] = value;
        };
    
        // Read in the credentials from the provided JSON file
        if (parameters.file) {
            parameters.developerConsoleCredentials = JSON.parse(fs.readFileSync(parameters.file));
        }
    
        console.log(parameters);
    
        return parameters;
    }
    
    async function getAccessToken(developerConsoleCredentials) {s
        if (developerConsoleCredentials.accessToken) {
            // This is a Local Development access token
            return developerConsoleCredentials.accessToken;
        } 
    }
    

    Rivedi le chiamate fetch(..) nei listAssetsByFolder(...) e updateMetadata(...) e osserva headers di definire l’intestazione di richiesta Authorization HTTP con un valore di Bearer ACCESS_TOKEN. In questo modo la richiesta HTTP proveniente dall’applicazione esterna si autentica in AEM as a Cloud Service.

    ...
    return fetch(`${params.aem}${ASSETS_HTTP_API}${folder}.json`, {
                method: 'get',
                headers: { 
                    'Content-Type': 'application/json',
                    'Authorization': 'Bearer ' + params.accessToken // Provide the AEM access token in the Authorization header
                },
    })...
    

    Eventuali richieste HTTP ad AEM as a Cloud Service devono impostare il token di accesso Bearer nell’intestazione Authorization. Ricorda che ogni ambiente AEM as a Cloud Service richiede il proprio token di accesso. Il token di accesso dello sviluppo non funziona su Stage o Produzione, Stage non funziona su Sviluppo o Produzione e Production non funziona su Sviluppo o Stage!

  6. Utilizzando la riga di comando, dalla radice del progetto esegui l’applicazione, passando i seguenti parametri:

    $ node index.js \
        aem=https://author-p1234-e5678.adobeaemcloud.com \
        folder=/wknd/en/adventures/napa-wine-tasting \
        propertyName=metadata/dc:rights \
        propertyValue="WKND Limited Use" \
        file=local_development_token.json
    

    Vengono passati i seguenti parametri:

    • aem: Lo schema e il nome host dell’ambiente AEM as a Cloud Service con cui l’applicazione interagisce (ad esempio, https://author-p1234-e5678.adobeaemcloud.com).
    • folder: Il percorso della cartella di risorse le cui risorse saranno aggiornate con propertyValue; NON aggiungere il /content/dam prefisso (ad es. /wknd/en/adventures/napa-wine-tasting)
    • propertyName: Nome della proprietà della risorsa da aggiornare, relativo a [dam:Asset]/jcr:content (ad esempio. metadata/dc:rights).
    • propertyValue: Il valore da impostare propertyName su; i valori con spazi devono essere incapsulati con " (es. "WKND Limited Use")
    • file: Il percorso relativo del file JSON scaricato da AEM Developer Console.

    L’esecuzione corretta dell’applicazione restituisce l’output per ogni risorsa aggiornata:

    200 - OK @ https://author-p1234-e5678.adobeaemcloud.com/api/assets/wknd/en/adventures/napa-wine-tasting.json
    200 - OK @ https://author-p1234-e5678.adobeaemcloud.com/api/assets/wknd/en/adventures/napa-wine-tasting/AdobeStock_277654931.jpg.json
    200 - OK @ https://author-p1234-e5678.adobeaemcloud.com/api/assets/wknd/en/adventures/napa-wine-tasting/AdobeStock_239751461.jpg.json
    200 - OK @ https://author-p1234-e5678.adobeaemcloud.com/api/assets/wknd/en/adventures/napa-wine-tasting/AdobeStock_280313729.jpg.json
    200 - OK @ https://author-p1234-e5678.adobeaemcloud.com/api/assets/wknd/en/adventures/napa-wine-tasting/AdobeStock_286664352.jpg.json
    

Verifica l'aggiornamento dei metadati in AEM

Verifica che i metadati siano stati aggiornati, accedendo all’ambiente AEM as a Cloud Service (assicurati che lo stesso host passato al parametro della riga di comando aem sia accessibile).

  1. Accedi all’ambiente AEM as a Cloud Service con cui l’applicazione esterna ha interagito (utilizza lo stesso host fornito nel parametro della riga di comando aem )
  2. Passa a Risorse > File
  3. Spostati nella cartella risorse specificata dal parametro della riga di comando folder, ad esempio WKND > Inglese > Avventure > Degustazione dei vini Napa
  4. Apri le Proprietà per qualsiasi risorsa (frammento non di contenuto) presente nella cartella
  5. Tocca la scheda Avanzate
  6. Rivedi il valore della proprietà aggiornata, ad esempio Copyright mappata alla proprietà metadata/dc:rights JCR aggiornata, che riflette il valore fornito nel parametro propertyValue, ad esempio WKND Limited Use

Aggiornamento dei metadati per uso limitato WKND

Passaggi successivi

Ora che abbiamo effettuato l’accesso a livello di programmazione ad AEM as a Cloud Service utilizzando il token di sviluppo locale, dobbiamo aggiornare l’applicazione per gestire l’utilizzo delle credenziali di servizio, in modo che questa applicazione possa essere utilizzata in un contesto di produzione.

In questa pagina