DocumentazioneExperience PlatformConfigurare Developer Console e Postman

Configura Developer Console e Postman

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Argomenti:
  • API

Creato per:

  • Principiante
  • Intermedio
  • Sviluppatore

In questa lezione verrà configurato un progetto in Adobe Developer Console e verranno scaricate 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. Sebbene non sia 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 le chiamate API e a scoprire come funzionano. Il resto di questo tutorial presuppone una certa conoscenza operativa di Postman. Per assistenza, fare riferimento alla 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.

Gli architetti di dati e i data engineer potrebbero dover utilizzare l'API di Platform al di fuori di questa esercitazione.

Autorizzazioni richieste

Nella lezione Configurare le autorizzazioni è possibile impostare tutti i controlli di accesso necessari per completare la lezione.

Configurare Adobe Developer Console

Adobe Developer Console è la destinazione per sviluppatori che consente di accedere a API e SDK di Adobe, ascoltare quasi 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, consulta la documentazione di Adobe Developer Console

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

  2. Apri Adobe Developer Console

  3. Accedi e verifica di essere nell’organizzazione corretta

  4. Selezionare Crea nuovo progetto nel menu Guida rapida.

    Crea nuovo progetto

  5. Nel nuovo progetto creato, seleziona il pulsante Modifica progetto

  6. Cambia il Titolo progetto in Luma Tutorial API Project (aggiungi il tuo nome alla fine, se più persone della tua azienda seguono questa esercitazione)

  7. Seleziona Salva

    Configurazione API progetto Adobe Developer Console

  8. Seleziona Aggiungi API

    Configurazione API progetto Adobe Developer Console

  9. Filtra l'elenco selezionando Adobe Experience Platform

  10. Nell'elenco delle API disponibili, selezionare Experience Platform API e Next.

    Configurazione API progetto Adobe Developer Console

  11. Seleziona OAuth Server-to-Server come credenziale e seleziona Next.
    Seleziona server-to-server OAuth

  12. Seleziona il profilo di prodotto AEP-Default-All-Users e seleziona Salva API configurata

    Seleziona profilo prodotto

  13. Ora il progetto Developer Console è stato creato.

  14. Nella sezione Prova della pagina, seleziona Scarica per Postman, quindi seleziona OAuth Server-to-Server per scaricare il file json dell'ambiente Postman. Salva oauth_server_to_server.postman_environment.json nella cartella Luma Tutorial Assets.

    Configurazione API progetto Adobe Developer Console

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:

  1. Il Nome delle credenziali API (Credential in Luma Tutorial API Project)

  2. L'e-mail account tecnico delle tue credenziali (aiuterà l'amministratore di sistema a trovare le credenziali)

    Nome e E-mail account tecnico delle credenziali

Seguono le istruzioni per l’amministratore di sistema:

  1. Accedi a Adobe Experience Platform

  2. Seleziona Autorizzazioni nella barra di navigazione a sinistra per passare alla schermata Ruoli

  3. Apri la mansione Luma Tutorial Platform
    Apri il ruolo

  4. Seleziona la scheda Credenziali API

  5. Seleziona Aggiungi credenziali API
    Aggiungi credenziali

  6. Trova le credenziali Credential in Luma Tutorial API Project filtrandole con l'E-mail account tecnico fornita dal partecipante all'esercitazione, se l'elenco è lungo

  7. Seleziona le credenziali

  8. Seleziona Salva

    Aggiungi credenziali

Configurare Postman

CAUTION
L’interfaccia di Postman viene aggiornata regolarmente. Le schermate di questo tutorial sono state scattate con Postman v10.15.1 per Mac, ma le opzioni dell’interfaccia potrebbero essere cambiate.

  1. Scarica e installa Postman

  2. Apri Postman e crea un'area di lavoro
    Importa ambiente

  3. Importa il file di ambiente json scaricato, oauth_server_to_server.postman_environment.json
    Importa ambiente

  4. In Postman, seleziona l'ambiente nel menu a discesa

  5. Seleziona l’icona per visualizzare le variabili di ambiente:

    Cambia ambiente

Aggiungere il nome della sandbox e l’ID tenant

Le variabili SANDBOX_NAME e TENANT_ID e CONTAINER_ID non sono incluse nell'esportazione Adobe Developer Console, pertanto le aggiungiamo manualmente:

  1. In Postman, apri le Variabili di ambiente

  2. Seleziona il collegamento Modifica a destra del nome dell'ambiente

  3. In Aggiungi nuovo campo variabile, immetti SANDBOX_NAME

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

  5. In Aggiungi nuovo campo variabile, immetti 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, il mio ID tenant è techmarketingdemos ma il tuo è diverso:

    Ottenimento dellID tenant dallURL dellinterfaccia di Platform

  7. Copia questo valore e torna alla schermata Postman Gestisci ambienti

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

  9. In Aggiungi nuovo campo variabile, immetti CONTAINER_ID

  10. Immetti global in entrambi i campi valore

    note note
    NOTE
    CONTAINER_ID è un campo il cui valore viene modificato più volte durante l'esercitazione. Quando si utilizza global, l'API interagisce con gli elementi forniti da Adobe nell'account Platform. Quando si utilizza tenant, l'API interagisce con i propri elementi personalizzati.

  11. Seleziona Salva

    Campi SANDBOX_NAME, TENANT_ID e CONTAINER_ID aggiunti come variabili di ambiente

Effettuare chiamate API

Recuperare un token di accesso

Adobe fornisce un set completo di Postman raccolte per esplorare l'API di Experience Platform. Queste raccolte si trovano nel repository GitHub Adobe Experience Platform Postman Samples. 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:

  1. Scarica la raccolta di API del servizio Identity Management nella cartella Luma Tutorial Assets

  2. Importa la raccolta in Postman

  3. Seleziona la richiesta oAuth: Richiedi token di accesso e seleziona Invia

  4. Dovresti ottenere una risposta 200 OK con un token di accesso nella risposta

    Richiedi i token

  5. Il token di accesso deve essere archiviato automaticamente come variabile di ambiente ACCESS_TOKEN dell'ambiente Postman.

    Postman

Interagire con un’API di Platform

Effettuiamo ora una chiamata API Platform per confermare che tutto è stato configurato correttamente.

Apri gli Experienci Platform Postman insiemi 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:

  1. Scarica la raccolta API del Registro di sistema dello schema 🔗 nella cartella Luma Tutorial Assets
  2. Importa in Postman
  3. Apri Schema Registry API > Schemi > Elenca schemi
  4. Osserva le schede Parametri e Intestazioni e osserva come includono alcune delle variabili di ambiente immesse in precedenza.
  5. Il campo Intestazioni > Accetta valore è impostato su application/vnd.adobe.xed-id+json. Le API del registro dello schema richiedono uno di questi valori di intestazione Accept specificati che forniscono formati diversi nella risposta.
  6. Seleziona Invia per effettuare la tua prima chiamata API Platform.

Si spera di aver ricevuto una risposta 200 OK corretta contenente un elenco degli schemi XDM forniti dall'Adobe disponibili nella sandbox, come illustrato di seguito.

Prima chiamata API in Postman

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 ti blocchi, chiedi aiuto nel Forum della community oppure utilizza il collegamento sul lato destro della pagina per "Segnalare un problema".

Con le autorizzazioni di Platform, la sandbox e Postman configurate, puoi modellare i dati negli schemi.

recommendation-more-help
513160b6-bf42-4c58-abdd-4f817b1cccad