Guida introduttiva a REST APIs getting-started-with-rest-apis
Informazioni su requisiti generali, autenticazione, parametri di query facoltativi, richiesta URLse altri riferimenti.
Requisiti API e Recommendations api-requirements-recommendations
Quando si lavora con API AUDIENCI MANAGER codice:
- Parametri di richiesta: tutti i parametri di richiesta sono obbligatori se non diversamente specificato.
- Intestazioni di richiesta: quando si utilizza Adobe Developer token, devi fornire
x-api-key
intestazione. Puoi ottenere il tuo API seguendo le istruzioni della sezione Integrazione dell’account del servizio pagina. - JSONtipo di contenuto: Specifica
content-type: application/json
eaccept: application/json
nel codice. - Richieste e risposte: Inviare richieste come formattate correttamente JSON oggetto. Audience Manager risponde con JSON dati formattati. Le risposte del server possono contenere i dati richiesti, un codice di stato o entrambi.
- Accesso: Il tuo Audience Manager il consulente ti fornirà un ID cliente e una chiave che ti consentano di API richieste.
- Documentazione ed esempi di codice: Testo in corsivo rappresenta una variabile fornita o trasmessa quando si crea o si riceve API dati. Sostituisci corsivo testo con codice, parametri o altre informazioni obbligatorie.
Autenticazione authentication
Il Audience Manager REST APIs supporta tre metodi di autenticazione.
- [Consigliato]{class="badge positive"}Autenticazione server-to-server OAuth utilizzo console per sviluppatori Adobe. Adobe Developer è l’ecosistema e la comunità di sviluppatori di Adobe. Include API per tutti i prodotti Adobe. Si tratta del metodo consigliato per impostare e utilizzare Adobe APIs. Ulteriori informazioni su Autenticazione server-to-server OAuth nella documentazione per gli sviluppatori Adobe.
- [Obsoleto]{class="badge negative"}Autenticazione JWT (account di servizio) utilizzo console per sviluppatori Adobe. Adobe Developer è l’ecosistema e la comunità di sviluppatori di Adobe. Include API per tutti i prodotti Adobe.
- [Obsoleto]{class="badge negative"}Autenticazione OAuth legacy. Anche se questo metodo è obsoleto, i clienti con OAuth le integrazioni possono continuare a utilizzare questo metodo.
Autenticazione server-to-server OAuth tramite Adobe Developer oauth-adobe-developer
Questa sezione illustra come raccogliere le credenziali necessarie per autenticare le chiamate API Audienci Manager, come descritto nel diagramma di flusso seguente. È possibile raccogliere la maggior parte delle credenziali richieste nella configurazione iniziale una tantum. Il token di accesso, tuttavia, deve essere aggiornato ogni 24 ore.
Panoramica di Adobe Developer developer-overview
Adobe Developer è l’ecosistema e la comunità di sviluppatori di Adobe. Include API per tutti i prodotti Adobe.
Si tratta del metodo consigliato per impostare e utilizzare Adobe APIs.
Prerequisiti prerequisites-server-to-server
Prima di configurare OAuth Server-to-Server autenticazione, assicurati di avere accesso al Console Adobe Developer in Adobe Developer. Contatta l’amministratore dell’organizzazione per le richieste di accesso.
Autenticazione oauth
Segui i passaggi seguenti per configurare OAuth Server-to-Server autenticazione tramite Adobe Developer:
- Accedi a Console Adobe Developer.
- Segui i passaggi descritti in Guida all'implementazione delle credenziali server-to-server di OAuth.
- Durante Passaggio 2: aggiungi un’API al progetto utilizzando l’autenticazione dell’account di servizio, scegli il Audience Manager API opzione.
- Prova la connessione effettuando la prima API effettua una chiamata in base alle istruzioni Passaggio 3.
Aggiungere l’API Audienci Manager a un progetto add-aam-api-to-project
Vai a Console Adobe Developer e accedi con il tuo Adobe ID. Quindi, segui i passaggi descritti nel tutorial su creazione di un progetto vuoto nella documentazione della console Adobe Developer.
Dopo aver creato un nuovo progetto, seleziona Add API il Project Overview schermo.
Il Add an API viene visualizzata la schermata. Seleziona l’icona del prodotto per Adobe Experience Cloud, quindi scegli Audience Manager API prima di selezionare Next.
Seleziona il tipo di autenticazione server-to-server OAuth select-oauth-server-to-server
Quindi, seleziona il tipo di autenticazione per generare token di accesso e accedere all’API Audienci Manager.
Selezionare i profili di prodotto per l’integrazione select-product-profiles
In Configure API , seleziona i profili di prodotto desiderati. L’account di servizio della tua integrazione potrà accedere a funzioni granulari tramite i profili di prodotto selezionati qui.
Seleziona Save configured API quando sei pronto.
Raccogli le credenziali gather-credentials
Una volta aggiunta l’API al progetto, la Audience Manager API Nella pagina del progetto vengono visualizzate le seguenti credenziali necessarie in tutte le chiamate alle API Audienci Manager:
{API_KEY}
(Client ID){ORG_ID}
(Organization ID)
Generare un token di accesso generate-access-token
Il passaggio successivo consiste nel generare un {ACCESS_TOKEN}
credenziali da utilizzare nelle chiamate API Audienci Manager. A differenza dei valori per {API_KEY}
e {ORG_ID}
, per continuare a utilizzare le API Audienci Manager, è necessario generare un nuovo token ogni 24 ore. Seleziona Generate access token, come illustrato di seguito.
Testare una chiamata API test-api-call
Dopo aver ottenuto il token Bearer di autenticazione, esegui una chiamata API per verificare che ora puoi accedere alle API Audienci Manager.
-
Accedi a Documentazione di riferimento API.
-
Seleziona Authorize e incolla il token di accesso ottenuto in genera token di accesso passaggio.
-
Effettuare una chiamata di GET al
/datasources
Endpoint API per recuperare un elenco di tutte le origini dati disponibili a livello globale, come indicato nella Documentazione di riferimento API. Seleziona Try it out, seguito da Execute, come illustrato di seguito.
code language-shell |
---|
|
Quando utilizzi un token di accesso funzionante, l’endpoint API restituisce una risposta 200 insieme a un corpo di risposta che include tutte le origini dati globali a cui l’organizzazione ha accesso.
code language-json |
---|
|
[Obsoleto]{class="badge negative"}JWT (Service Accounta) Autenticazione tramite Adobe Developer jwt
Panoramica di Adobe Developer adobeio
Adobe Developer è l’ecosistema e la comunità di sviluppatori 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 JWT autenticazione, assicurati di avere accesso al Console Adobe Developer in Adobe Developer. Contatta l’amministratore dell’organizzazione per le richieste di accesso.
Autenticazione auth
Segui i passaggi seguenti per configurare JWT (Service Account) autenticazione tramite Adobe Developer:
- Accedi a Console Adobe Developer.
- Segui i passaggi descritti in Connessione account di servizio.
- Durante Passaggio 2: aggiungi un’API al progetto utilizzando l’autenticazione dell’account di servizio, scegli il Audience Manager API opzione.
- Prova la connessione effettuando la prima API effettua una chiamata in base alle istruzioni Passaggio 3.
note note |
---|
NOTE |
Per configurare e utilizzare Audience Manager REST APIs in modo automatico, puoi generare il JWT a livello di programmazione. Consulta Autenticazione JWT (account di servizio) per istruzioni dettagliate. |
Autorizzazioni RBAC dell’account tecnico
Se il tuo account di Audience Manager utilizza Controllo degli accessi basato sul ruolo, devi creare un account utente tecnico Audienci Manager e aggiungerlo al gruppo RBAC Audienci Manager che effettuerà le chiamate API.
Per creare un account utente tecnico e aggiungerlo a un gruppo RBAC, effettua le seguenti operazioni:
-
Crea un
GET
chiama ahttps://aam.adobe.io/v1/users/self
. La chiamata creerà un account utente tecnico che potrai visualizzare nella Admin Console, nella Users pagina. -
Accedi al tuo account Audienci Manager e aggiungere l’account utente tecnico al gruppo di utenti che effettuerà le chiamate API.
[Obsoleto]{class="badge negative"}OAuth Autenticazione (obsoleto) oauth-deprecated
note warning |
---|
WARNING |
Audience Manager REST API autenticazione e rinnovo dei token tramite OAuth 2.0 è ora obsoleto. |
Utilizza Autenticazione JWT (account di servizio) invece. |
Il Audience Manager REST API segue OAuth 2.0 standard per l’autenticazione e il rinnovo dei token. Le sezioni seguenti descrivono come eseguire l’autenticazione e iniziare a utilizzare APIs.
Crea un generico API Utente requirements
È consigliabile creare un account utente tecnico separato per l'utilizzo di Audience Manager APIs. Si tratta di un account generico non associato o associato a un utente specifico dell'organizzazione. Questo tipo di API l’account utente ti consente di eseguire 2 operazioni:
- Identifica il servizio che chiama API (ad esempio, chiamate dalle app che utilizzano il nostro APIs o da altri strumenti che API richieste).
- Fornire accesso ininterrotto al APIs. Un account associato a una persona specifica può essere cancellato quando lascia la tua azienda. Questo ti impedirà di lavorare con i API codice. 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 tu voglia modificare molti segmenti contemporaneamente con Strumenti di gestione in blocco. Bene, per fare questo, il tuo account utente ha bisogno di API accesso. Invece di aggiungere le autorizzazioni a un utente specifico, crea un’ API account utente con credenziali, chiave e segreto appropriati API chiamate. Questa funzione è utile anche per sviluppare applicazioni personalizzate che utilizzano Audience Manager APIs.
Utilizzare Audience Manager consulente per la creazione di un generico, APIaccount utente di sola lettura.
Flusso di lavoro di autenticazione password password-authentication-workflow
Autenticazione tramite password accesso sicuro REST API. I passaggi seguenti descrivono il flusso di lavoro per l’autenticazione tramite password da un JSON nel browser.
note tip |
---|
TIP |
Crittografare i token di accesso e di aggiornamento se vengono memorizzati in un database. |
Passaggio 1: richiesta API Accesso
Contatta il tuo Partner Solutions Manager. Ti forniranno un API ID client e segreto. L’ID e il segreto ti autenticano nel API.
Nota: se desideri ricevere un token di aggiornamento, specificalo quando richiedi API accesso.
Passaggio 2: richiedere il token
Passa una richiesta di token con il tuo preferito JSON client. Quando crei la richiesta:
- Utilizza un
POST
metodo di chiamatahttps://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
convertire indGVzdElkOnRlc3RTZWNyZXQ=
. - Passa il HTTP headers
Authorization:Basic <base-64 clientID:clientSecret>
eContent-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
Il JSON la risposta contiene il token di accesso. La risposta deve essere simile alla seguente:
code language-json |
---|
|
Il expires_in
key 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 token di rinnovo API dopo la scadenza del token originale. Se richiesto, la risposta JSON nel flusso di lavoro della password è incluso 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, viene visualizzato un messaggio 401 Status Code
e la seguente intestazione nella risposta:
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 JSON nel browser.
Passaggio 1: richiesta del nuovo token
Trasmettere una richiesta di token di aggiornamento con il token preferito JSON client. Quando crei la richiesta:
- Utilizza un
POST
metodo di chiamatahttps://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
convertire indGVzdElkOnRlc3RTZWNyZXQ=
. - Passa le intestazioni HTTP
Authorization:Basic <base-64 clientID:clientSecret>
eContent-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
Il JSON la risposta contiene il nuovo token di accesso. La risposta deve essere simile alla seguente:
code language-json |
---|
|
Codice di autorizzazione e autenticazione implicita authentication-code-implicit
Il Audience Manager REST API supporta il codice di autorizzazione e l’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.
Rendi autenticato API Richieste authenticated-api-requests
Requisiti per il servizio di chiamata API metodi dopo aver ricevuto un token di autenticazione.
Per effettuare chiamate rispetto alla disponibilità API metodi:
- In
HTTP
intestazione, setAuthorization: Bearer <token>
. - Quando si utilizza Autenticazione JWT (account di servizio), devi fornire
x-api-key
, che sarà lo stesso dell'intestazioneclient_id
. Puoi ottenere il tuoclient_id
dal Integrazione con Adobe Developer pagina. - Chiama il necessario API metodo.
Facoltativo API Parametri di query optional-api-query-parameters
Impostare i parametri facoltativi disponibili per i metodi che restituiscono tutte le proprietà di un oggetto.
Questi parametri facoltativi possono essere utilizzati con API metodi che restituiscono tutto proprietà di un oggetto. Imposta queste opzioni nella stringa di richiesta quando trasmetti la query al API.
page
pageSize
sortBy
descending
ascending
è l'impostazione predefinita.search
GET https://aam.adobe.io/v1/models/?search=Test
. Puoi eseguire ricerche in base a qualsiasi valore restituito da un "get allmetodo ".folderId
permissions
Restituisce un elenco di segmenti in base all’autorizzazione specificata. READ
è l'impostazione predefinita. Le autorizzazioni includono:
READ
: restituisce e visualizza informazioni su un segmento.WRITE
: UtilizzarePUT
per aggiornare un segmento.CREATE
: UtilizzarePOST
per creare un segmento.DELETE
: elimina un segmento. Richiede l’accesso alle caratteristiche sottostanti, se presenti. Ad esempio, per rimuoverlo, dovrai disporre dei diritti necessari per eliminare le caratteristiche che appartengono a un segmento.
Specifica più autorizzazioni con coppie chiave-valore separate. Ad esempio, per restituire un elenco di segmenti con READ
e WRITE
solo autorizzazioni, passare "permissions":"READ"
, "permissions":"WRITE"
.
includePermissions
true
per restituire le autorizzazioni per il segmento. Il valore predefinito è false
.Nota Sulle Opzioni Di Pagina
Quando le informazioni della pagina non è specificata, la richiesta restituisce solo JSON restituisce un array. Se le informazioni della pagina è specificato, l'elenco restituito viene racchiuso in un JSON oggetto che contiene informazioni sul risultato totale e sulla pagina corrente. Un esempio di richiesta tramite le opzioni di pagina potrebbe essere simile al seguente:
GET https://aam.adobe.io/v1/models/?page=1&pageSize=2&search=Test
API URLs api-urls
URLs per richieste, ambienti di staging e produzione e versioni.
Richiesta URLs request-urls
Nella tabella seguente sono elencate le richieste URLs utilizzato per trasmettere API richieste, per metodo.
A seconda del metodo di autenticazione utilizzato, è necessario modificare la richiesta URLs secondo le tabelle che seguono.
Richiesta URLs per [Consigliato]{class="badge positive"}[Obsoleto]{class="badge negative"}JWT Autenticazione tramite Adobe Developer request-urls-jwt
https://aam.adobe.io/v1/models/
https://aam.adobe.io/v1/datasources/
https://aam.adobe.io/v1/signals/derived/
https://aam.adobe.io/v1/destinations/
https://aam.adobe.io/v1/partner-sites/
https://aam.adobe.io/v1/folders/traits /
Segmenti:
https://aam.adobe.io/v1/folders/segments /
https://aam.adobe.io/v1/schemas/
https://aam.adobe.io/v1/segments/
https://aam.adobe.io/v1/traits/
https://aam.adobe.io/v1/customer-trait-types
https://aam.adobe.io/v1/taxonomies/0/
Richiesta URLs per [Obsoleto]{class="badge negative"}OAuth Autenticazione request-urls-oauth
https://api.demdex.com/v1/models/
https://api.demdex.com/v1/datasources/
https://api.demdex.com/v1/signals/derived/
https://api.demdex.com/v1/destinations/
https://api.demdex.com/v1/partner-sites/
https://api.demdex.com/v1/folders/traits /
Segmenti:
https://api.demdex.com/v1/folders/segments /
https://api.demdex.com/v1/schemas/
https://api.demdex.com/v1/segments/
https://api.demdex.com/v1/traits/
https://api.demdex.com/v1/customer-trait-types
https://api.demdex.com/v1/taxonomies/0/
Ambienti environments
Il Audience Manager APIfornisce accesso a diversi ambienti di lavoro. Questi ambienti consentono di testare il codice su database separati senza influire sui dati live e di produzione. Nella tabella seguente sono elencate le opzioni API e i nomi host delle risorse corrispondenti.
A seconda del metodo di autenticazione utilizzato, è necessario modificare l’ambiente URLs secondo la tabella seguente.
https://aam.adobe.io/...
https://api.demdex.com/...
https://aam-beta.adobe.io/...
https://api-beta.demdex.com/...
Versioni versions
Nuove versioni di questi APIvengono rilasciati regolarmente. Una nuova versione incrementa il API numero di versione. Nella richiesta viene fatto riferimento al numero di versione URL as v<version number>
come mostrato nell'esempio seguente:
https://<host>/v1/...
Codici di risposta definiti response-codes-defined
HTTP
codici di stato e testo di risposta restituiti da Audience Manager REST API.
200
OK
201
Created
PUT
e POST
richieste.204
No Content
400
Bad Request
403
Forbidden
404
Not Found
409
Conflict
500
Server Error