Présentation des API d’Audience Manager

 

Avant de démarrer:

Vous avez besoin de quelques éléments avant de commencer à travailler avec les API d’AAM. Vous aurez besoin des éléments suivants :

  • L’accès à l’API doit être accordé.
  • Un ID client.
  • Un secret API.
  • Un logiciel pour faciliter les demandes d’API (je recommande une application autonome Google Chrome appelée Postman, mais d’autres comme CuRL peuvent également être utilisées).

Pour obtenir ces informations, contactez votre consultant ou l’équipe d’assistance clientèle AAM.

Une fois que vous avez obtenu ces informations vous devez coder l’ID client et le secret API à l’aide du codage de la base 64. La chaîne codée doit être écrite au format suivant :

clientid:secret

 

Vous pouvez utiliser un emplacement tel que base64encode.com pour que le codage.

Le codage obtenu se présentera comme suit : bXljbGllbnRpZDpteWFwaXNlY3JldA==

 

Aperçu du document :

Cliquez sur un lien ci-dessous pour accéder à cette section du document.

 

Configuration de votre client (Postman).

Demander un jeton d’accès.

D’autres exemples.

 

Installez votre client :

Comme nous l’avons vu auparavant, plusieurs options différentes s’offrent à vous lorsque vous choisissez un client HTTP.  Ce document traite d’une application Chrome autonome intitulée Postman.

Vous pouvez obtenir Postman ici : http://www.getpostman.com/.

 

Postman offre de nombreuses fonctionnalités qui facilitent l’organisation ou l’utilisation de requêtes HTTP.  L’application se décompose en deux sections principales.  Sur la gauche est un champ de recherche, ainsi que la possibilité d’examiner l’historique des demandes et de stocker les requêtes dans les collections.  Le reste de l’application est dédié à la compilation et à l’envoi des demandes.

 

La création d’une requête dans Postman est un processus relativement simple.  Pour les requêtes HTTP en général, il faut connaître le type de requête à effectuer, l’URL à cibler et les paramètres requis.  Comme chaque requête est différente, il est recommandé de référencer la documentation de l’API pour vous assurer que vous disposez des informations nécessaires.

 

Remarque : Avant de pouvoir effectuer toute requête contre l’API, vous devez d’abord demander un jeton d’accès. Consultez Demander un jeton d’accès pour plus d’informations.

 

Une fois que vous connaissez le type de demande à faire, commencez par spécifier le type de demande en le sélectionnant dans la liste déroulante.

Ensuite, saisissez l’URL API dans le champ URL.  Il doit être au format suivant : « https://api.demdex.com/v1/traits/ ».

La dernière étape consiste à définir les paramètres de demande.  Pour ce faire, saisissez les valeurs variées dans les onglets « En-têtes » ou « Corps ».

 

Les en-têtes changent légèrement selon la requête envoyée, mais elles contiennent généralement les trois éléments suivants :

 

  • Accepter | application/json
  • Autorisation | Porteur <access token>
  • Contenu-Type | application/json

Le corps change également en fonction du type de requête envoyée, ainsi que de l’URL (ou de l’extrémité) ciblée.  En règle générale, les valeurs sont fournies dans un bloc JSON formaté contenant les paires de données.

Avec d’autres requêtes, les valeurs sont fournies dans les paramètres.

 

Une fois que tout a été configuré pour la demande, vous pouvez l’envoyer en cliquant sur le bouton « Envoyer » dans le coin supérieur droit, ou l’enregistrer dans une collection en cliquant sur le bouton du disque.

 

Demande de jeton d’accès :

Le premier appel d’API à passer est pour demander un jeton d’accès.  Pour ce faire, il faut soumettre une requête POST à « https://api.demdex.com/oauth/token ».  Dans le cadre de la publication, définissez plusieurs en-têtes et autres paramètres.

 

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

 

En-têtes:

Accepter : application/json
Autorisation : Basique <jeton encodé base 64>

 

Type de formulaire : x-www-form-urlencoded

 

Corps de demande (clé individuelle:paires de valeurs) :

grant_type : mot de passe
nom d’utilisateur : <nom d’utilisateur du client AAM>
mot de passe : <Mot de passe du client AAM>

 

Exemple 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

 

Autres occurrences :

Voici quelques exemples supplémentaires pour vous aider à utiliser l’API.

 

Création d’une caractéristique :

Type de requête HTTP : Post.

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

En-têtes:

  • Accepter : application/json.
  • Autorisation : Porteur <access token>
  • Content-Type : application/json.

Corps de demande :

Lors de la création d’une nouvelle
caractéristique, il faut définir la structure et le type de caractéristique, ainsi que les règles qu’elle doit suivre.  Certaines des valeurs requises incluent le type, le nom, la description, et les règles de la caractéristique, l’identifiant de la source de données et l’identifiant du dossier parent. Pour plus d’informations, consultez https://marketing.adobe.com/resources/help/en_US/aam/?f=c_methods.

{
	"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
}

 

Demandez toutes les caractéristiques basées sur des règles :

Type de requête HTTP : Get.

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

En-têtes:

  • Accepter : application/json.
  • Autorisation : Porteur <access token>
  • Content-Type : application/json.

Corps de la demande : S/O.

 

Documentation de l’API

Pour plus d’informations sur les possibilités offertes par les API, consultez notre page de documentation.

Ce produit est distribué sous licence Creative Commons Attribution - Pas d’utilisation commerciale - Partage à l’identique 3.0 non transposé  Les publications Twitter™ et Facebook ne sont pas couvertes par les dispositions Creative Commons.

Mentions légales   |   Politique de confidentialité en ligne