Introduzione all'API di Audience Manager

 

Prima di iniziare:

Ci sono alcune cose da sapere prima di poter iniziare a lavorare con le API AAM. Ti serve:

  • È necessario disporre dell'accesso all'API.
  • Un customer ID (chiamato anche ID cliente o Client ID).
  • Un segreto API.
  • Software per facilitare le richieste API (consiglio un'applicazione stand alone di Google Chrome chiamata Postman, ma possono essere utilizzati anche altri, tra cui CuRL).

Per ottenere queste informazioni, rivolgiti al tuo consulente o al team di assistenza clienti AAM.

Una volta ottenute queste informazioni sarà necessario codificare l'ID cliente e il segreto API utilizzando la codifica base 64. La stringa codificata deve essere nel seguente formato:

clientid:secret

 

Puoi usare un sito come base64encode.com per fare la codifica.

La codifica risultante avrà un aspetto simile a questo: bXljbGllbnRpZDpteWFwaXNlY3JldA==

 

Panoramica del documento

Fai clic su un link qui sotto per saltare a quella sezione del documento

 

Impostazione del client (Postman)

Richiesta di un token di accesso (Access Token)

Altri esempi

 

Impostare il proprio Client

Come accennato in precedenza, ci sono diverse opzioni Internet quando si sceglie un client HTTP.  In questo documento, mi concentrerò su un'applicazione stand alone di Chrome chiamata Postman.

Puoi trovare Postman qui: http://www.getpostman.com/

 

Postman offre un sacco di caratteristiche molto utili che rendono l'organizzazione o il lavoro con le richieste HTTP un piacere.  L'applicazione è suddivisa in due sezioni principali.  A sinistra c'è un campo di ricerca, così come la possibilità di guardare la storia delle tue richieste e di memorizzare le richieste nelle collezioni.  Il resto dell'applicazione è dedicato alla compilazione e all'invio delle richieste.

 

Creare una richiesta in Postman è un processo abbastanza semplice.  Per le richieste HTTP in generale, dobbiamo conoscere il tipo di richiesta che faremo, l'URL target e i parametri richiesti.  Poiché ogni richiesta è diversa, si raccomanda di fare riferimento alla documentazione delle API per assicurarsi di avere le informazioni necessarie.

 

Nota: prima di poter effettuare qualsiasi richiesta all'API, è necessario richiedere un token di accesso. Per ulteriori informazioni, vedi Richiesta di un token di accesso (Access Token).

 

Una volta che si conosce il tipo di richiesta che si desidera effettuare, inizia specificando il tipo di richiesta selezionandola dall'elenco a discesa.

Quindi, inserisci l'URL API nel campo URL.  Questo dovrebbe essere nel formato "https://api.demdex.com/v1/traits/".

Il passo finale è la definizione dei parametri della richiesta.  Questo viene fatto inserendo vari valori nelle schede "Headers" o "Body".

 

Le intestazioni cambiano leggermente a seconda della richiesta inviata, ma generalmente contengono i tre elementi seguenti:

 

  • Accept | application/json
  • Autorizzazione | Supporto <token di accesso>
  • Content-Type | application/json

Il corpo cambia a seconda sia del tipo di richiesta inviata sia dell'URL (o endpoint) target.  Generalmente, i valori sono forniti in un blocco formato JSON che contiene le varie coppie di dati.

Con altre richieste, i valori saranno invece forniti in parametri.

 

Una volta che tutto è stato impostato per la richiesta, è possibile inviarla cliccando sul pulsante "Invia" in alto a destra, oppure salvarla in una collezione cliccando sul pulsante a forma di dischetto.

 

Richiesta di un token di accesso (Access Token)

La prima chiamata API che dobbiamo fare è per richiedere un token di accesso.  Per farlo, invieremo una richiesta POST a "https://api.demdex.com/oauth/token".  Come parte del POST, dobbiamo definire diverse intestazioni e altri parametri.

 

URL: https://api.demdex.com/oauth/token

 

Intestazioni:

Accettare: applicazione/json
Autorizzazione : Base <token codificato 64 di base>

 

Tipo di modulo: x-www-form-urlencoded

 

Request Body (individual key:value pairs):

grant_type : password
username : <AAM Customer Username>
password : <AAM Customer Password>

 

Esempio Curl:

curl -X POST -H "Accept: application/json"
-H "Authorization: Basic " -H
"Cache-Control: no-cache" -H "Content-Type:
application/x-www-form-urlencoded" -d
'grant_type=password&username=&password=' https://api.demdex.com/oauth/token

 

Altri esempi:

Ecco alcuni esempi aggiuntivi per aiutarti a iniziare a usare l'API.

 

Creare un tratto

Tipo di richiesta HTTP: Post

URL: https://api.demdex.com/v1/traits/ 

Intestazioni:

  • Accept: application/json
  • Autorizzazione: Supporto <token di accesso>
  • Content-Type: application/json

Corpo della richiesta:

Quando si crea un nuovo
tratto, dobbiamo definire sia la struttura e il tipo di tratto, sia le regole che il tratto seguirà.  Alcuni dei valori richiesti includono il tipo di tratto, il nome del tratto, la descrizione del tratto, la regola del tratto, l'id della sorgente dati e l'id della cartella padre. Per ulteriori informazioni: https://marketing.adobe.com/resources/help/en_US/aam/c_methods.html.

{
	"traitType": "RULE_BASED_TRAIT",
	"name": "Blog Post",
	"description": "Tracks when a blog post has been created within the Demo app",
	"comments": "",
	"integrationCode": "post-1",
	"traitRule": "blogPostID==\"1\"",
	"dataSourceId": 14266,
	"folderId": 81659
}

 

Richiedi tutte i tratti basati su regole

HTTP Request Type: Get

URL: https://api.demdex.com/v1/traits/?restrictType=RULE_BASED_TRAIT

Intestazioni:

  • Accept: application/json
  • Autorizzazione: Supporto <token di accesso>
  • Content-Type: application/json

Corpo della richiesta: N/D

 

Documentazione dell’API

Per maggiori informazioni su cosa si può fare con le API, si prega di fare riferimento alla nostra pagina di documentazione.

Questo prodotto è concesso in licenza in base alla licenza di Attribuzione-Non commerciale-Condividi allo stesso modo 3.0 Unported di Creative Commons.  I post su Twitter™ e Facebook non sono coperti dai termini di Creative Commons.

Note legali   |   Informativa sulla privacy online