Configurare Console sviluppatori e Postman
In questa lezione, configurerai un progetto nella console Adobe Developer e lo scaricherai Postman affinché tu possa iniziare a utilizzare le API di Platform.
Per completare gli esercizi API descritti in questa esercitazione, scarica l’app Postman per il tuo sistema operativo. Anche se non è necessario per utilizzare le API Experience Platform, Postman semplifica i flussi di lavoro API e Adobe Experience Platform fornisce decine di raccolte Postman per aiutarti a eseguire chiamate API e a imparare come funzionano. Il resto di questo tutorial presuppone una certa conoscenza operativa di Postman. Per assistenza, fai riferimento a Documentazione di Postman.
La piattaforma è stata creata prima in base alle API. Sebbene esistano opzioni di interfaccia anche per tutte le attività principali, a un certo punto potresti voler utilizzare l’API di Platform. Ad esempio, per acquisire i dati, spostare gli elementi da una sandbox all’altra, automatizzare le attività di routine o utilizzare le nuove funzioni di Platform prima che l’interfaccia utente sia stata generata.
Architetti di dati e Ingegneri dati potrebbe essere necessario utilizzare l’API di Platform al di fuori di questa esercitazione.
Autorizzazioni richieste
In Configurare le autorizzazioni Per completare questa lezione, è necessario impostare tutti i controlli di accesso necessari.
Configurare la console Adobe Developer
La console Adobe Developer è la destinazione per sviluppatori che consente di accedere a API e SDK Adobe, ascoltare eventi in tempo reale, eseguire funzioni in fase di esecuzione o creare plug-in o applicazioni App Builder. Lo utilizzerai per accedere all’API Experience Platform. Per ulteriori dettagli, vedi Documentazione della console Adobe Developer
-
Crea una cartella sul computer locale denominata
Luma Tutorial Assets
per i file utilizzati nell’esercitazione. -
Accedi e verifica di essere nell’organizzazione corretta
-
Seleziona Crea nuovo progetto in Guida rapida menu.
-
Nel progetto appena creato, seleziona la Modifica Progetto pulsante
-
Modificare il Titolo progetto a
Luma Tutorial API Project
(aggiungi il tuo nome alla fine, se più persone della tua azienda stanno seguendo questo tutorial) -
Seleziona Salva
-
Seleziona Aggiungi API
-
Filtra l’elenco selezionando Adobe Experience Platform
-
Nell’elenco delle API disponibili, seleziona API EXPERIENCE PLATFORM e seleziona Successivo.
-
Seleziona OAuth Server-to-Server come credenziali e seleziona Successivo.
-
Seleziona la
AEP-Default-All-Users
profilo di prodotto e seleziona Salva API configurata -
Ora il progetto Console sviluppatori è stato creato.
-
In Provatelo sezione della pagina, seleziona Scarica per Postman e quindi seleziona OAuth Server-to-Server per scaricare Postman file json dell’ambiente. Salva il
oauth_server_to_server.postman_environment.json
nel tuoLuma Tutorial Assets
cartella.
Chiedi a un amministratore di sistema di aggiungere le credenziali API al ruolo
Per utilizzare le credenziali API per interagire con Experience Platform, è necessario che un amministratore di sistema assegni le credenziali API al ruolo creato nella lezione precedente. Se non sei un amministratore di sistema, puoi inviarli:
-
Il Nome delle credenziali API (
Credential in Luma Tutorial API Project
) -
Il E-mail account tecnico delle credenziali (in questo modo l’amministratore di sistema potrà trovare le credenziali)
Seguono le istruzioni per l’amministratore di sistema:
-
Accedi a Adobe Experience Platform
-
Seleziona Autorizzazioni nella barra di navigazione a sinistra, che consente di accedere al Ruoli screen
-
Apri
Luma Tutorial Platform
ruolo
-
Seleziona la Credenziali API scheda
-
Seleziona Aggiungi credenziali API
-
Trova il
Credential in Luma Tutorial API Project
credenziali, filtro con E-mail account tecnico fornito dal partecipante all’esercitazione, se l’elenco è lungo -
Seleziona le credenziali
-
Seleziona Salva
Configurare Postman
-
Scarica e installa Postman
-
Apri Postman e creare un’area di lavoro
-
Importare il file di ambiente json scaricato
oauth_server_to_server.postman_environment.json
-
In entrata Postman, seleziona l’ambiente nel menu a discesa
-
Seleziona l’icona per visualizzare le variabili di ambiente:
Aggiungere il nome della sandbox e l’ID tenant
Il SANDBOX_NAME
e TENANT_ID
e CONTAINER_ID
Le variabili non sono incluse nell’esportazione della console Adobe Developer, per cui le aggiungiamo manualmente:
-
In entrata Postman, apri Variabili di ambiente
-
Seleziona la Modifica collegamento a destra del nome dell’ambiente
-
In Aggiungi nuovo campo variabile, immetti
SANDBOX_NAME
-
In entrambi i campi valore, immetti
luma-tutorial
, il nome che abbiamo dato alla sandbox nella lezione precedente. Se hai utilizzato un nome diverso per la sandbox, ad esempio luma-tutorial-ignatiusjreilly, assicurati di utilizzare tale valore. -
In Aggiungi nuovo campo variabile, immetti
TENANT_ID
-
Passa al browser web e cerca l’ID tenant della tua azienda andando nell’interfaccia di Experience Platform ed estraendo la porzione dell’URL dopo il simbolo @. Ad esempio, il mio ID tenant è
techmarketingdemos
ma il tuo è diverso: -
Copia questo valore e torna al Postman Schermata Gestisci ambienti
-
Incolla l’ID tenant in entrambi i campi valore
-
In Aggiungi nuovo campo variabile, immetti
CONTAINER_ID
-
Invio
global
in entrambi i campi valorenote note NOTE CONTAINER_ID
è un campo il cui valore viene modificato più volte durante l’esercitazione. Quandoglobal
interagisce con gli elementi forniti da Adobe nell’account Platform. Quandotenant
Se viene utilizzato, l’API interagisce con i tuoi elementi personalizzati. -
Seleziona Salva
Effettuare chiamate API
Recuperare un token di accesso
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 archivio GitHub. Applica un segnalibro a questo archivio, in quanto lo utilizzerai numerose volte durante questa esercitazione e in seguito durante l’implementazione di Experience Platform per la tua azienda.
La prima raccolta funziona con le API Adobe Identity Management Service (IMS). È un modo pratico per recuperare un token di accesso da Postman.
Per generare il token di accesso:
-
Scarica il file Raccolta API del servizio Identity Management al tuo
Luma Tutorial Assets
cartella -
Importa la raccolta in Postman
-
Seleziona la richiesta oAuth: richiedi token di accesso richiedi e seleziona Invia
-
Dovresti ricevere un
200 OK
risposta con un token di accesso nella risposta -
Il token di accesso deve essere memorizzato automaticamente come ACCESS_TOKEN variabile di ambiente del Postman ambiente.
Interagire con un’API di Platform
Effettuiamo ora una chiamata API Platform per confermare che tutto è stato configurato correttamente.
Apri Experience Platform Postman raccolte in GitHub. In questa pagina sono presenti molte raccolte, per diverse API di Platform. Raccomando vivamente di segnalibro.
Ora effettuiamo la nostra prima chiamata API:
- Scarica il file Raccolta API del registro dello schema al tuo
Luma Tutorial Assets
cartella - Importa in Postman
- Apri Schema Registry API > Schemi > Elenca schemi
- Osserva la Parametri e Intestazioni e annota come includono alcune delle variabili di ambiente immesse in precedenza.
- Tieni presente che Intestazioni > Campo Accetta valore è impostato su
application/vnd.adobe.xed-id+json
. Le API del registro dello schema richiedono una di queste valori di intestazione Accept specificati che forniscono formati diversi nella risposta. - Seleziona Invia per effettuare la tua prima chiamata API Platform.
Speriamo che tu abbia avuto successo 200 OK
risposta contenente un elenco degli schemi XDM forniti dall’Adobe disponibili nella sandbox, come illustrato di seguito.
Se la chiamata non ha avuto esito positivo, attendi un attimo a eseguire il debug utilizzando i dettagli della risposta di errore della chiamata API e controlla i passaggi precedenti. Se si blocca, richiedere assistenza nella Forum della community In alternativa, utilizza il collegamento sul lato destro della pagina per "Segnalare un problema".
Con le autorizzazioni della piattaforma, la sandbox e Postman , è possibile eseguire le operazioni seguenti: dati modello negli schemi!