Authenticate and access Experience Platform APIs

This document provides a step-by-step tutorial for gaining access to an Adobe Experience Platform developer account in order to make calls to Experience Platform APIs.

Autenticazione per effettuare chiamate API

Per mantenere la sicurezza delle applicazioni e degli utenti, tutte le richieste a API Adobe I/O devono essere autenticate e autorizzate utilizzando standard quali OAuth e JSON Web Token (JWT). Il JWT viene quindi utilizzato insieme alle informazioni specifiche per il cliente per generare il token di accesso personale.

Questa esercitazione descrive i passaggi dell'autenticazione mediante la creazione di un token di accesso delineato nel seguente diagramma di flusso:

Prerequisiti

Per effettuare correttamente le chiamate alle Experience Platform API, è necessario quanto segue:

• Un'organizzazione IMS con accesso ad Adobe Experience Platform
• Un account Adobe ID registrato
• Un amministratore Admin Console per aggiungere voi come sviluppatore e come utente per un prodotto.

Le sezioni seguenti descrivono i passaggi necessari per creare un Adobe ID e diventare sviluppatore e utente per un'organizzazione.

Creare un Adobe ID

Se non disponete di un Adobe ID , potete crearne uno seguendo la procedura seguente:

1. Vai a Adobe Developer Console
2. Fai clic su create a new account.
3. Completare il processo di registrazione

Diventare sviluppatore e utente per Experience Platform un'organizzazione

Prima di creare integrazioni su Adobe I/O, il vostro account deve disporre delle autorizzazioni per lo sviluppatore per un prodotto in un'organizzazione IMS. Informazioni dettagliate sugli account sviluppatore nel Admin Console sono disponibili nel documento di supporto per la gestione degli sviluppatori.

Accesso sviluppatore

Contatta un Admin Console amministratore dell’organizzazione per aggiungere l’utente come sviluppatore per uno dei prodotti dell’organizzazione che utilizza l’ Admin Console.

L'amministratore deve assegnare l'utente come sviluppatore ad almeno un profilo di prodotto per continuare.

Una volta assegnati come sviluppatore, potrete disporre dei privilegi di accesso per creare integrazioni su Adobe I/O. Queste integrazioni sono una pipeline dalle app e dai servizi esterni all'API del Adobe .

Accesso utente

L’ Admin Console amministratore deve anche aggiungere l’utente al prodotto come utente.

Come per la procedura di aggiunta di uno sviluppatore, l’amministratore deve assegnarvi almeno un profilo di prodotto per poter procedere.

Generazione di credenziali di accesso in Adobe Developer Console

Utilizzando Adobe Developer Console, è necessario generare le seguenti tre credenziali di accesso:

• {IMS_ORG}
• {API_KEY}
• {ACCESS_TOKEN}

È necessario generare {IMS_ORG} e {API_KEY} solo una volta e riutilizzarli in chiamate Platform API future. Tuttavia, {ACCESS_TOKEN} è temporaneo e deve essere rigenerato ogni 24 ore.

I passaggi sono descritti in dettaglio di seguito.

Configurazione una tantum

Andate a console per sviluppatori di Adobi ed effettuate l'accesso con il vostro Adobe ID . Attenetevi quindi ai passaggi descritti nell'esercitazione sulla creazione di un progetto vuoto nella documentazione di Adobe Developer Console.

Dopo aver creato un nuovo progetto, fate clic Add API sulla schermata Panoramica ​​progetto.

Viene visualizzata la schermata Aggiungi un'API . Fate clic sull'icona del prodotto per Adobe Experience Platform, quindi selezionate Experience Platform API prima di fare clic su Next.

Dopo aver selezionato Experience Platform come API da aggiungere al progetto, segui i passaggi descritti nell'esercitazione sull' aggiunta di un'API a un progetto utilizzando un account di servizio (JWT) (a partire dal passaggio "Configura API") per completare il processo.

Una volta aggiunta l'API al progetto, la pagina di panoramica del progetto visualizza le seguenti credenziali che sono richieste in tutte le chiamate alle Experience Platform API:

• {API_KEY} (ID client)
• {IMS_ORG} (ID organizzazione)

Autenticazione per ogni sessione

L'ultima credenziale richiesta da raccogliere è la tua {ACCESS_TOKEN}. A differenza dei valori per {API_KEY} e {IMS_ORG}, è necessario generare un nuovo token ogni 24 ore per continuare a utilizzare Platform le API.

Per generare un nuovo {ACCESS_TOKEN}, seguite i passaggi per generare un token JWT nella guida alle credenziali della console per sviluppatori.

Verifica credenziali di accesso

Dopo aver raccolto tutte e tre le credenziali necessarie, puoi provare a effettuare la seguente chiamata API. Questa chiamata elenca tutte le classi Experience Data Model (XDM) all'interno del global contenitore del Registro di sistema dello schema:

Formato API

GET /global/classes

Richiesta

curl -X GET https://platform.adobe.io/data/foundation/schemaregistry/global/classes \
  -H 'Accept: application/vnd.adobe.xed-id+json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}'

Risposta

Se la risposta è simile a quella mostrata di seguito, le credenziali sono valide e funzionanti. Questa risposta è stata troncata per lo spazio.

{
  "results": [
    {
        "title": "XDM ExperienceEvent",
        "$id": "https://ns.adobe.com/xdm/context/experienceevent",
        "meta:altId": "_xdm.context.experienceevent",
        "version": "1"
    },
    {
        "title": "XDM Individual Profile",
        "$id": "https://ns.adobe.com/xdm/context/profile",
        "meta:altId": "_xdm.context.profile",
        "version": "1"
    }
  ]
}

Utilizzare Postman per l'autenticazione JWT e le chiamate API

Postman è uno strumento popolare per lavorare con le API RESTful. Questo post Medium descrive come impostare postman per eseguire automaticamente l'autenticazione JWT e usarlo per utilizzare le API Adobe Experience Platform.

Passaggi successivi

Leggendo questo documento, hai raccolto e verificato con successo le credenziali di accesso per Platform le API. Ora puoi seguire le chiamate API di esempio fornite nell'intera documentazione.

Oltre ai valori di autenticazione raccolti in questa esercitazione, molte Platform API richiedono anche che come intestazione sia {SANDBOX_NAME} disponibile una valida. Per ulteriori informazioni, consultate la panoramica delle sandbox.