En esta guía, se describen las API de Adobe Customer Journey Analytics (CJA) y se proporciona información detallada sobre la extracción de datos, las soluciones personalizadas y la integración de terceros. La guía incluye la configuración de acceso, claves de API, pruebas con Postman, un ejemplo de llamada API paso a paso y sugerencias para usuarios nuevos.

¿No tiene experiencia con las API y se pregunta cómo las API de Adobe Customer Journey Analytics (CJA) pueden ayudarle? ¡No se preocupe! En esta guía para principiantes, le guiaremos por los aspectos básicos, desglosaremos la jerga y le ayudaremos a dar sus primeros pasos en el emocionante mundo de las API de CJA.

Imagine tener el poder de acceder y analizar sus datos de CJA mediante programación, sin ningún esfuerzo manual. ¡Eso es exactamente lo que le permiten hacer las API de CJA!

Considere las API como mensajeros: llevan sus solicitudes a los servidores de Adobe y devuelven los resultados en un paquete perfectamente organizado.

Una configuración de éxito seguro

Antes de realizar la primera llamada API, debe configurar el acceso y los permisos adecuados. En primer lugar, asegúrese de que se le añade como desarrollador en su organización. A continuación, compruebe que tiene acceso a los perfiles de producto con los permisos necesarios.

Paso 1: Obtener la clave de API
  1. Inicie sesión en Adobe Developer Console.
  2. Cree un nuevo proyecto, agréguele la API de Customer Journey Analytics y seleccione los perfiles de producto necesarios.
  3. Haga clic en Agregar al proyecto y añada también la API de Adobe Experience Platform al proyecto.
  4. Una vez completada la configuración, tendrá toda la información necesaria en la pestaña Credenciales de la izquierda.

Estos son los tres parámetros de encabezado básicos necesarios para todas las solicitudes de API:

Asegúrese de guardar estas credenciales, ya que son sus claves para desbloquear la potencia de las API. En la sección Introducción de la API de CJA, se incluyen instrucciones paso a paso más detalladas.

Paso 2: Probar la configuración

Una buena manera de probar las API sin escribir ningún código es con herramienta Postman, potente y fácil de usar. Después de iniciar la aplicación, puede importar fácilmente sus credenciales de API y comenzar a experimentar con solicitudes GET simples para comprobar que su conexión y la autenticación funcionan correctamente. Se recomienda iniciar el recorrido de las pruebas de API con solicitudes GET, porque se consideran más seguras y no destructivas, ya que solo recuperan datos del servidor y no realizan ninguna modificación. Esto contrasta con otros métodos HTTP como las solicitudes POST, PUT o DELETE, que pueden alterar o eliminar datos en el servidor y, por lo tanto, deben probarse con más precaución.

Su primera llamada API

Vamos a hacer algo sencillo: obtener una lista de las vistas de datos disponibles en su cuenta de CJA.

Ejemplo: Enumerar vistas de datos

Punto final:
GET https://cja.adobe.io/data/dataviews

Encabezados:

x-api-key: {API_KEY}

x-gw-ims-org-id: {IMS_ORG_ID}

Authorization: Bearer {AUTHORIZATION_TOKEN}

Solicitud CURL:

curl -X GET "https://cja.adobe.io/data/dataviewsexpansion=name%2Cowner%2Corganization%2Cdescription"\

-H "x-api-key: {API_KEY}" \

-H "x-gw-ims-org-id: {IMS_ORG_ID}" \

-H "Authorization: Bearer {AUTHORIZATION_TOKEN}"

También puede probar estas solicitudes en la documentación de punto final de la API de CJA usando la función Try It (Pruébelo). Este es el vínculo para probar la solicitud anterior.

Solo tiene que hacer clic en la CTA Try It (Pruébelo) e introducir todos los parámetros obligatorios, en este caso, los parámetros de encabezado que hemos comentado y pulsar en Send (Enviar).

También puede incluir parámetros adicionales para personalizar la solicitud. Encontrará una lista de los parámetros disponibles en la sección Parámetros de consulta para cada solicitud de API en la documentación de la API de CJA.

Estos son los códigos de respuesta HTTP clave que encontrará cuando trabaje con API:

Estos códigos de estado indican a los desarrolladores exactamente lo que ha sucedido durante una solicitud de API, lo que facilita la resolución de problemas.

NOTE
Cuando use la función Try It (Pruébelo), asegúrese de que el token de acceso del campo Authorization lleve el prefijo "Bearer". Si omite o escribe incorrectamente este prefijo, se generará un error 401.

Sugerencias para usuarios de API sin experiencia previa

  1. Comprobar su acceso: asegúrese de que dispone de los niveles correctos de permisos y que se le ha agregado a los perfiles de producto correctos. No tener el acceso correcto es la causa raíz más común de errores de solicitudes de API.
  2. Probar, probar y probar: use la función Try It (Pruébelo) en la documentación de punto final de API o Postman para experimentar con solicitudes antes de escribir código.
  3. Comience poco a poco: empiece por solicitudes GET simples y vaya avanzando hasta las consultas POST.
  4. Usar la documentación: la documentación de la API de CJA de Adobe es su mejor amiga. Compruebe con regularidad si hay actualizaciones, ya que es posible que las configuraciones anteriores no funcionen según lo esperado después de realizar actualizaciones importantes.
  5. Hacer preguntas: no dude en ponerse en contacto con la Comunidad de Adobe Analytics de Experience League para obtener ayuda.

Empezar a usar las API de CJA de Adobe puede parecer intimidante al principio, pero con un poco de práctica, automatizará los flujos de trabajo y descubrirá información útil en poco tiempo. Por lo tanto, dé el primer paso: inicie sesión, obtenga sus credenciales y pruebe una llamada API simple. ¡Su aventura con las API le espera!

style
article-content-section
5 minutos
style
article-header-section