Guida introduttiva a REST APIs getting-started-with-rest-apis

Panoramica di Adobe Developer adobeio

Adobe Developer è l'ecosistema di sviluppatori e la community di Adobe. Include API per tutti i prodotti Adobe.

Si tratta del metodo consigliato per impostare e utilizzare Adobe APIs.

Prerequisiti prerequisites

Prima di configurare l'autenticazione di JWT, verificare di avere accesso a Adobe Developer Console in Adobe Developer. Contatta l’amministratore dell’organizzazione per le richieste di accesso.

Autenticazione auth

Per configurare l'autenticazione di JWT (Service Account) tramite Adobe Developer, attenersi alla procedura seguente:

1. Accedi a Adobe Developer Console.
2. Segui i passaggi descritti in Connessione account di servizio.
   • Durante il passaggio 2: aggiungi un'API al progetto utilizzando l'autenticazione dell'account di servizio, scegli l'opzione Audience Manager API.
3. Provare la connessione effettuando la prima chiamata API in base alle istruzioni del passaggio 3.

Autorizzazioni RBAC dell’account tecnico

Se l'account Audience Manager utilizza Controllo degli accessi basato sul ruolo, è necessario creare un account utente tecnico Audience Manager e aggiungerlo al gruppo RBAC Audience Manager che effettuerà le chiamate API.

Per creare un account utente tecnico e aggiungerlo a un gruppo RBAC, effettua le seguenti operazioni:

1. Effettuare una chiamata GET a https://aam.adobe.io/v1/users/self. La chiamata creerà un account utente tecnico visibile in Admin Console, nella pagina Users.

   

2. Accedi al tuo account Audience Manager e aggiungi l'account utente tecnico al gruppo di utenti che effettuerà le chiamate API.

Audience Manager REST API segue gli standard OAuth 2.0 per l'autenticazione e il rinnovo dei token. Le sezioni seguenti descrivono come eseguire l'autenticazione e iniziare a lavorare con API.

Crea un utente API generico requirements

È consigliabile creare un account utente tecnico separato per l'utilizzo di Audience Manager API. Si tratta di un account generico non associato o associato a un utente specifico dell’organizzazione. Questo tipo di account utente API consente di eseguire 2 operazioni:

• Identifica il servizio che chiama API (ad esempio, chiamate dalle app che utilizzano API o da altri strumenti che effettuano API richieste).
• Fornisci accesso ininterrotto a API. Un account associato a una persona specifica può essere cancellato quando lascia la tua azienda. In questo modo non sarà possibile utilizzare il codice API disponibile. Un account generico non legato a un dipendente specifico consente di evitare questo problema.

Come esempio o caso d'uso per questo tipo di account, supponiamo che si desideri modificare molti segmenti contemporaneamente con i Strumenti di gestione in blocco. Bene, per fare questo, il tuo account utente ha bisogno dell'accesso a API. Anziché aggiungere le autorizzazioni a un utente specifico, creare un account utente API non specifico con credenziali, chiave e segreto appropriati per effettuare chiamate a API. Questa funzione è utile anche se si sviluppano applicazioni personalizzate che utilizzano Audience Manager API.

Rivolgiti al tuo consulente Audience Manager per configurare un account utente generico di API.

Flusso di lavoro di autenticazione password password-authentication-workflow

Autenticazione password accesso sicuro REST API. I passaggi seguenti descrivono il flusso di lavoro per l'autenticazione tramite password da un client JSON nel browser.

Passaggio 1: richiesta dell'accesso API

Contatta il tuo Partner Solutions Manager. Ti forniranno un ID client API e un segreto. L'ID e il segreto ti autenticano in API.

Nota: se si desidera ricevere un token di aggiornamento, specificarlo quando si richiede l'accesso API.

Passaggio 2: richiedere il token

Trasmettere una richiesta token con il client JSON preferito. Quando crei la richiesta:

• Utilizzare un metodo POST per chiamare https://api.demdex.com/oauth/token.
• Converti l’ID client e il segreto in una stringa con codifica base 64. Durante il processo di conversione, separa l’ID e il segreto con due punti. Ad esempio, le credenziali testId : testSecret vengono convertite in dGVzdElkOnRlc3RTZWNyZXQ=.
• Passa HTTP headers Authorization:Basic <base-64 clientID:clientSecret> e Content-Type: application/x-www-form-urlencoded. Ad esempio, l'intestazione potrebbe essere simile alla seguente:
  Authorization: Basic dGVzdElkOnRlc3RTZWNyZXQ=
Content-Type: application/x-www-form-urlencoded
• Imposta il corpo della richiesta come segue:
  
  grant_type=password&username=<your-AudienceManager-user-name>&password=<your-AudienceManager-password>

Passaggio 3: ricevere il token

La risposta di JSON contiene il token di accesso. La risposta deve essere simile alla seguente:

{
    "access_token": "28fed402-eafd-456c-9341-ac753f25bbbc",
    "token_type": "bearer",
    "refresh_token": "b27122c0-b0c7-4b39-a71b-1547a3b3b88e",
    "expires_in": 21922,
    "scope": "read write"
}

La chiave expires_in rappresenta il numero di secondi rimanenti alla scadenza del token di accesso. Come best practice, utilizza tempi di scadenza brevi per limitare l’esposizione se il token viene mai esposto.

Aggiorna token refresh-token

Aggiorna i token per rinnovare l'accesso API dopo la scadenza del token originale. Se richiesto, la risposta JSON nel flusso di lavoro della password include un token di aggiornamento. Se non ricevi un token di aggiornamento, creane uno nuovo tramite il processo di autenticazione tramite password.

Puoi anche utilizzare un token di aggiornamento per generare un nuovo token prima della scadenza del token di accesso esistente.

Se il token di accesso è scaduto, nella risposta riceverai un 401 Status Code e la seguente intestazione:

WWW-Authenticate: Bearer realm="oauth", error="invalid_token", error_description="Access token expired: <token>"

I passaggi seguenti descrivono il flusso di lavoro per l'utilizzo di un token di aggiornamento per creare un nuovo token di accesso da un client JSON nel browser.

Passaggio 1: richiesta del nuovo token

Trasmettere una richiesta di token di aggiornamento con il client JSON preferito. Quando crei la richiesta:

• Utilizzare un metodo POST per chiamare https://api.demdex.com/oauth/token.
• Converti l’ID client e il segreto in una stringa con codifica base 64. Durante il processo di conversione, separa l’ID e il segreto con due punti. Ad esempio, le credenziali testId : testSecret vengono convertite in dGVzdElkOnRlc3RTZWNyZXQ=.
• Passa le intestazioni HTTP Authorization:Basic <base-64 clientID:clientSecret> e Content-Type: application/x-www-form-urlencoded. Ad esempio, l'intestazione potrebbe essere simile alla seguente:
  Authorization: Basic dGVzdElkOnRlc3RTZWNyZXQ=
Content-Type: application/x-www-form-urlencoded
• Nel corpo della richiesta, specifica grant_type:refresh_token e passa il token di aggiornamento ricevuto nella richiesta di accesso precedente. La richiesta deve essere simile alla seguente:
  grant_type=refresh_token&refresh_token=b27122c0-b0c7-4b39-a71b-1547a3b3b88e

Passaggio 2: ricevere il nuovo token

La risposta di JSON contiene il nuovo token di accesso. La risposta deve essere simile alla seguente:

{
    "access_token": "4fdfc261-2ffc-4fb7-8dbd-64221714c45f",
    "token_type": "bearer",
    "refresh_token": "295fa487-1825-4caa-a715-80b81ac17dae",
    "expires_in": 21922,
    "scope": "read write"
}

Codice di autorizzazione e autenticazione implicita authentication-code-implicit

Audience Manager REST API supporta codice di autorizzazione e autenticazione implicita. Per utilizzare questi metodi di accesso, gli utenti devono accedere a https://api.demdex.com/oauth/authorize per accedere e aggiornare i token.