Configurare Developer Console e Postman

In questa lezione, configurerai un progetto nella Console per sviluppatori di Adobe e scaricherai Postman raccolte per iniziare a utilizzare le API di Platform.

Per completare gli esercizi API in questa esercitazione, scarica l’app Postman per il tuo sistema operativo. Anche se non è necessario per utilizzare le API di Experience Platform, Postman semplifica i flussi di lavoro API e Adobe Experience Platform fornisce decine di raccolte Postman per aiutarti a eseguire le chiamate API e imparare come funzionano. Il resto di questo tutorial presuppone una certa conoscenza di lavoro di Postman. Per assistenza, fare riferimento al Documentazione del postino.

Platform è la prima API integrata. Sebbene esistano anche opzioni di interfaccia per tutte le attività principali, a un certo punto potrebbe essere utile utilizzare l’API di Platform. Ad esempio, per acquisire i dati, spostare gli elementi tra le sandbox, automatizzare le attività di routine o utilizzare nuove funzioni di Platform prima che l’interfaccia utente sia stata creata.

Architetti dei dati e Ingegneri dati potrebbe essere necessario utilizzare l’API di Platform al di fuori di questa esercitazione.

Autorizzazioni necessarie

In Configurare le autorizzazioni per completare la lezione, è necessario impostare tutti i controlli di accesso necessari.

Configurare Adobe Developer Console

  1. Crea una cartella nel computer locale denominata Luma Tutorial Assets per i file utilizzati nell’esercitazione.

  2. Apri Console per sviluppatori di Adobe

  3. Accedi e conferma di essere nell'organizzazione corretta

  4. Seleziona Crea nuovo progetto in Guida introduttiva menu.

    Crea nuovo progetto

  5. Nel nuovo progetto creato, seleziona la Aggiungi a progetto quindi seleziona API

    Configurazione dell’API per progetti Adobe Developer Console

  6. Filtrare l’elenco selezionando Adobe Experience Platform

  7. Nell’elenco delle API disponibili, seleziona API Experience Platform e seleziona Successivo.

    Configurazione dell’API per progetti Adobe Developer Console

  8. Per l'autenticazione da sistemi esterni come Postman, è necessaria una coppia di chiavi pubblica/privata. Per generare una nuova coppia di chiavi, seleziona Opzione 1 e premere Genera coppia di chiavi pulsante

    Configurazione dell’API per progetti Adobe Developer Console

  9. Quando le chiavi sono pronte, potrebbe essere richiesto di scaricare le chiavi sul computer locale. Salva le chiavi incluse in config.zip nella cartella Luma Tutorial Assets. Ne avremo bisogno nel prossimo esercizio.

  10. Una volta generata la chiave, la chiave pubblica verrà aggiunta automaticamente al progetto come mostrato nella schermata . Seleziona la Successivo pulsante .

     Visualizza dopo la generazione e la selezione della chiave

  11. Seleziona la Luma Tutorial Platform profilo di prodotto e seleziona il Salva API configurata pulsante

    Seleziona profilo prodotto

  12. Ora è stato creato il tuo progetto Console per sviluppatori .

  13. In Provate della pagina, seleziona Scarica per Postman quindi seleziona Account di servizio (JWT) per scaricare Postman file json di ambiente. Salva il service.postman_environment.json nel tuo Luma Tutorial Assets cartella.

    Configurazione dell’API per progetti Adobe Developer Console

    NOTA

    Gli amministratori di sistema della tua organizzazione possono visualizzare il progetto come "Credenziale API" nel profilo di prodotto nell’Admin Console

    Configurazione dell’API per progetti Adobe Developer Console

Avrete notato che al progetto è stato assegnato un numero, ad esempio "Progetto 12":

  1. Seleziona il numero del progetto nella breadcrumb.

  2. Seleziona la Modifica progetto pulsante

  3. Modificare la Titolo del progetto a Luma Tutorial API Project (aggiungi il tuo nome alla fine, se più persone della tua azienda stanno seguendo questa esercitazione)

  4. Seleziona la Salva pulsante

    Configurazione dell’API per progetti Adobe Developer Console

Imposta Postman

ATTENZIONE

L’interfaccia Postman viene aggiornata regolarmente. Le schermate di questa esercitazione sono state scattate con Postman v9.0.5 per Mac, ma le opzioni di interfaccia potrebbero essere cambiate.

  1. Scarica e installa Postman

  2. Apri Postman e importare il file di ambiente json scaricato, service.postman_environment.json
    Ambiente di importazione

  3. In Postman, seleziona l’ambiente nel menu a discesa

    Cambiare ambiente

  4. Seleziona la occhio per visualizzare le variabili di ambiente:

    Configurazione dell’API per progetti Adobe Developer Console

Aggiorna nome ambiente

Poiché il nome esportato dell’ambiente da Developer Console viene generato in modo casuale, assegnagli un nome più descrittivo in modo da non confondere gli ambienti in un secondo momento quando inizi a lavorare sull’implementazione effettiva di Platform:

  1. Con la schermata delle variabili di ambiente ancora aperta, seleziona Modifica in alto a destra

  2. Aggiorna Nome dell'ambiente a Luma Tutorial

  3. Esci Gestire gli ambienti apertura modale in modalità di modifica, in quanto la modificheremo ulteriormente nel passaggio successivo

    Aggiorna il nome dell'ambiente Postman

Aggiungi la chiave privata

Ora è il momento di aggiungere il valore PRIVATE_KEY all’ambiente Postman

  1. Estrai il download config.zip file generato nell’esercizio precedente durante la creazione del progetto Console per sviluppatori. Questo file zip contiene due file:

    • private.key
    • certificate_pub.crt
  2. Apri private.key in un editor di testo e copia il contenuto.

  3. A Postman, sul Gestire gli ambienti > Modifica modale ancora aperto dall'ultimo esercizio, incolla i valori copiati davanti a PRIVATE_KEY in Valore iniziale e Valore corrente colonne.

  4. Seleziona Salva

    Chiave privata incollata in Postman

Aggiungi i token JWT e Access

Adobe fornisce un set completo di Postman raccolte per esplorare le API di Experience Platform. Queste raccolte sono nel Adobe Experience Platform Postman Esempi di repository GitHub. Aggiungi ai segnalibri questo repository in quanto lo utilizzi più volte durante questo tutorial e successivamente durante l'implementazione di Experience Platform per la tua azienda.

La prima raccolta funziona con le API Adobe Identity Management Service (IMS). È un modo conveniente per popolare i JWT_TOKEN e ACCESS_TOKEN da Postman destinati a casi d'uso non di produzione ad esempio, per completare questa esercitazione nella sandbox. In alternativa, puoi generare il token JWT all’interno di Adobe Developer Console. Tuttavia, poiché scade regolarmente, l’utilizzo di questa raccolta consente di aggiornarla senza dover rivisitare nuovamente Adobe Developer Console durante il completamento di questa esercitazione.

AVVERTENZA

Come rilevato nella sezione README API di Adobe Identity Management Service, i metodi di generazione indicati sono idonei per uso non di produzione. La firma locale carica una libreria JavaScript da un host di terze parti e la firma remota invia la chiave privata a un servizio Web di proprietà e gestito da Adobe. Sebbene Adobe non memorizzi questa chiave privata, le chiavi di produzione non devono mai essere condivise con nessuno.

Per generare i token:

  1. Scarica la Raccolta per la generazione di token di accesso alla Console per sviluppatori al tuo Luma Tutorial Assets cartella

  2. Importa la raccolta in Postman

  3. Seleziona la richiesta IMS: JWT Genera + Auth tramite token utente e seleziona Invia

    Richiedere i token

  4. La JWT_TOKEN e ACCESS_TOKEN compilazione automatica nelle variabili di ambiente di Postman.

    Postman

Aggiungere il nome della sandbox e l’ID tenant

La SANDBOX_NAME e TENANT_ID e CONTAINER_ID le variabili non sono incluse nell’esportazione di Adobe Developer Console, pertanto le aggiungiamo manualmente:

  1. In Postman, apri Variabili di ambiente

  2. Seleziona la Modifica collegamento a destra del nome dell’ambiente

  3. In Aggiungi nuovo campo variabile, inserisci SANDBOX_NAME

  4. In entrambi i campi di valore, immetti luma-tutorial, il nome che abbiamo dato alla sandbox nella lezione precedente. Se hai usato un nome diverso per la sandbox, ad esempio luma-tutorial-ignatiusjreilly, assicurati di utilizzare tale valore.

  5. In Aggiungi nuovo campo variabile, inserisci TENANT_ID

  6. Passa al browser web e cerca l’ID tenant della tua azienda andando nell’interfaccia di Experience Platform ed estraendo la parte dell’URL dopo il simbolo @. Ad esempio, l’ID tenant è techmarketingdemos ma il tuo è diverso:

    Ottenimento dell’ID tenant dall’URL dell’interfaccia di Platform

  7. Copia questo valore e torna al Postman Schermata Gestisci ambienti

  8. Incolla l’ID tenant in entrambi i campi del valore

  9. In Aggiungi nuovo campo variabile, inserisci CONTAINER_ID

  10. Invio global in entrambi i campi valore

    NOTA

    CONTAINER_ID è un campo il cui valore viene modificato più volte durante l’esercitazione. Quando global viene utilizzato, l’API interagisce con gli elementi forniti da Adobe nel tuo account Platform. Quando tenant viene utilizzato e l’API interagisce con i tuoi elementi personalizzati.

  11. Seleziona Salva

    I campi SANDBOX_NAME, TENANT_ID e CONTAINER_ID sono stati aggiunti come variabili di ambiente

Effettuare una chiamata API Platform

Ora effettuiamo una chiamata API Platform per confermare che abbiamo configurato tutto correttamente.

Apri Experience Platform Postman raccolte in GitHub. Ci sono molte raccolte in questa pagina, per diverse API di Platform. Raccomando vivamente di segnalarlo.

Ora, effettuiamo la nostra prima chiamata API:

  1. Scarica la Raccolta API del Registro di sistema dello schema al tuo Luma Tutorial Assets cartella
  2. Importa in Postman
  3. Apri API del Registro di sistema dello schema > Classi > Recupera un elenco di classi all’interno del contenitore specificato.
  4. Guarda il Parametri e Intestazioni e noterai come includono alcune delle variabili di ambiente immesse in precedenza.
  5. Tieni presente che Intestazioni > Campo valore Accetta è impostato su application/vnd.adobe.xed-id+json. Le API del Registro di sistema dello schema richiedono una di queste valori di intestazione Accept specificati che forniscono formati diversi nella risposta.
  6. Seleziona Invia per effettuare la tua prima chiamata API Platform .

Speriamo che tu abbia avuto successo 200 OK risposta contenente un elenco delle classi XDM standard disponibili nella sandbox, come illustrato di seguito.

Prima chiamata API in Postman

Se la chiamata non è riuscita, effettua il debug utilizzando i dettagli della risposta dell’errore nella chiamata API e controlla i passaggi precedenti. Se ti trovi bloccato, chiedi aiuto nel Forum della community oppure utilizza il collegamento sul lato destro della pagina per "Segnalare un problema".

Risorse aggiuntive

Con le autorizzazioni Platform, sandbox e Postman configurare, è possibile dati del modello negli schemi!

In questa pagina