Introducción a la API de Audience Manager

 

Antes de empezar:

Antes de empezar a trabajar con las API de AAM, necesita ciertos elementos. Qué necesitará:

  • Se debe conceder acceso a la API.
  • Un identificador de cliente (también llamado ID de cliente).
  • Un secreto de la API.
  • Software para facilitar las solicitudes de API (se recomienda una aplicación independiente de Google Chrome llamada Postman, pero también se pueden utilizar otras como CuRL).

Para obtener esta información, póngase en contacto con su asesor o con el equipo de atención al cliente de AAM.

Una vez que haya obtenido esta información, deberá codificar el ID de cliente y el secreto de la API utilizando la codificación de base 64. La cadena codificada debe tener el siguiente formato:

clientid:secret

 

Para hacer la codificación, puede usar un sitio como base64encode.com.

La codificación resultante se verá de la siguiente manera: bXljbGllbnRpZDpteWFwaXNlY3JldA==

 

Descripción general del documento:

Haga clic en uno de los siguientes enlaces para ir a esa sección del documento

 

Configuración del cliente (Postman)

Solicitud de un token de acceso

Otros ejemplos

 

Configuración del cliente:

Como se mencionó anteriormente, existen diferentes opciones a la hora de elegir un cliente HTTP.  En este documento, me voy a centrar en una aplicación autónoma de Chrome llamada Postman.

Puede conseguir la aplicación Postman aquí: http://www.getpostman.com/

 

Postman ofrece un montón de funciones útiles que hacen que organizar o trabajar con peticiones HTTP sea realmente agradable.  La aplicación se divide en dos secciones principales.  A la izquierda hay un campo de búsqueda, así como la posibilidad de ver el historial de solicitudes y de almacenar las solicitudes en recopilaciones.  El resto de la aplicación se dedica a la compilación y envío de solicitudes.

 

La creación de una solicitud en Postman es un proceso bastante sencillo.  Para las solicitudes HTTP en general, necesitamos saber el tipo de solicitud que vamos a hacer, la URL a la que nos dirigimos y los parámetros requeridos.  Puesto que cada solicitud es diferente, se recomienda que haga referencia a la documentación de la API para asegurarse de que dispone de la información necesaria.

 

Nota: Antes de poder realizar cualquier solicitud contra la API, debe solicitar un token de acceso. Para obtener más información, consulte Solicitud de un token de acceso.

 

Una vez que sepa el tipo de solicitud que desea realizar, comience por especificarla seleccionándola en el menú desplegable.

A continuación, introduzca la URL de la API en el campo URL.  El formato debe ser el siguiente: “https://api.demdex.com/v1/traits/”.

El paso final consiste en definir los parámetros de la solicitud.  Para llevarlo a cabo, debe introducir varios valores en las pestañas Encabezados o Cuerpo.

 

Los encabezados cambian ligeramente dependiendo de la solicitud que se envía, pero generalmente contienen los siguientes tres elementos:

 

  • Aceptar | aplicación/json
  • Autorización | Portador <token de acceso>
  • Tipo de contenido | aplicación/json

Asimismo, el cuerpo también cambia dependiendo tanto del tipo de solicitud que se envía, así como la URL (o punto de conexión) a la que nos dirigimos.  Por lo general, los valores se suministran en un bloque con formato JSON que contiene los distintos pares de datos.

Con otras solicitudes, los valores se suministrarán en parámetros en su lugar.

 

Una que se haya configurado todo para la solicitud, puede enviarla haciendo clic en el botón Enviar, situado en la parte superior derecha, o guardarla en una colección haciendo clic en el botón del disco.

 

Solicitud de un token de acceso:

La primera llamada a la API que necesitamos hacer es para solicitar un token de acceso.  Para ello, enviaremos una solicitud de entrada a “https://api.demdex.com/oauth/token”.  Como parte de la entrada, necesitamos definir varios encabezados, así como otros parámetros.

 

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

 

Encabezados:

Aceptar: aplicación/json
Autorización: básico <token codificado con base 64>

 

Tipo de formulario: x-www-form-urlencoded

 

Cuerpo de la solicitud (clave individual:pares de valores):

tipo_concesión : contraseña
nombre de usuario : <nombre de usuario del cliente de AAM>
contraseña : <contraseña del cliente de AAM>

 

Ejemplo de 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

 

Otros ejemplos:

A continuación mostramos algunos ejemplos adicionales para ayudarle a empezar a utilizar la API.

 

Creación de un rasgo:

Tipo de solicitud HTTP: entrada

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

Encabezados:

  • Aceptar: application/json
  • Autorización: portador <token de acceso>
  • Tipo de contenido: application/json

Cuerpo de la solicitud:

Al crear un nuevo rasgo
, debemos definir tanto la estructura y el tipo de rasgo como las reglas que este seguirá.  Algunos de los valores requeridos incluyen el tipo, nombre, descripción y regla del rasgo, el ID de la fuente de datos y el ID de la carpeta principal. Para más información, visite 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
}

 

Solicitar todos los rasgos basados en reglas:

Tipo de solicitud HTTP: Obtener

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

Encabezados:

  • Aceptar: application/json
  • Autorización: Portador <access token>
  • Tipo de contenido: application/json

Cuerpo de la solicitud: N/A

 

Documentación de API

Para más información sobre lo que puede hacer con las API, consulte nuestra página de documentación.

Esta obra está autorizada con arreglo a la licencia de Reconocimiento-NoComercial-CompartirIgual 3.0 Unported de Creative Commons.  Los términos de Creative Commons no cubren las publicaciones en Twitter™ y Facebook.

Avisos legales   |   Política de privacidad en línea