Esta guía abarca las API de Adobe Customer Journey Analytics (CJA), con detalles sobre la extracción de datos, soluciones personalizadas e integración con terceros. Incluye la configuración de acceso, claves API, pruebas con Postman, un ejemplo paso a paso de una llamada API y sugerencias para quienes se inician.
¿Eres nuevo en las API y te preguntas cómo pueden ayudarte las API de Adobe Customer Journey Analytics (CJA)? ¡No te preocupes! En esta guía para principiantes te explicamos lo esencial, aclaramos los términos y te ayudamos a dar tus primeros pasos en el mundo de las API de CJA.
Imagina poder acceder y analizar tus datos de CJA de forma programática, sin esfuerzo manual. Eso es precisamente lo que te permiten las API de CJA.
- Extrae datos de forma eficiente: optimiza la extracción de datos con llamadas API.
- Crea soluciones personalizadas: diseña e implementa flujos de informes automatizados adaptados a las necesidades específicas de tu negocio.
- Conecta sin complicaciones: permite un flujo de datos fluido entre CJA y aplicaciones de terceros mediante integraciones robustas.
Piensa en las API como mensajeros: llevan tus solicitudes a los servidores de Adobe y te devuelven los resultados en un formato ordenado.
Preparar la configuración para el éxito
Antes de realizar tu primera llamada API, es necesario configurar el acceso y los permisos adecuados. Primero, asegúrate de que te hayan añadido como desarrollador en tu organización. Después, comprueba que tienes acceso a los perfiles de producto con los permisos necesarios.
Paso 1: obtener tu clave API
- Inicia sesión en Adobe Developer Console.
- Crear un nuevo proyecto y añadir la API de Customer Journey Analytics a tu proyecto, y seleccionar los perfiles de producto requeridos.
- Haz clic en Añadir al proyecto y añade también la API de Adobe Experience Platform al proyecto
- Una vez completada la configuración, podrás obtener toda la información necesaria en la pestaña Credenciales del menú de la izquierda.
Estos son los tres parámetros de cabecera esenciales que se requieren en todas las solicitudes de API:
- Token de acceso: garantiza que solo las personas autorizadas accedan a los datos y se puede generar haciendo clic en el CTA Generar token de acceso que aparece destacado en la captura de pantalla. Este parámetro se denomina autorización en la solicitud de API.
- ID de cliente: también conocido como clave de API, se denomina x-api-key en la solicitud de API.
- ID de organización: se denomina x-gw-ims-org-id en la solicitud de API.
Guarda estas credenciales; son la clave para desbloquear todo el potencial de la API. Puedes consultar instrucciones detalladas paso a paso en la sección Introducción de la API de CJA.
Paso 2: Prueba tu configuración
Una forma sencilla de probar las API sin escribir código es utilizar la potente y fácil de usar herramienta Postman. Tras iniciar la aplicación, puedes importar fácilmente tus credenciales de API y comenzar a experimentar con peticiones GET simples para comprobar que la conexión y la autenticación funcionan correctamente. Se recomienda comenzar las pruebas de API con peticiones GET, ya que se consideran más seguras y no destructivas, pues solo recuperan datos del servidor sin realizar modificaciones. Esto contrasta con otros métodos HTTP como las peticiones POST, PUT o DELETE, que pueden modificar o eliminar datos en el servidor y, por tanto, deben probarse con mayor precaución.
Realizar tu primera llamada API
Vamos a hacer algo sencillo: obtener una lista de las vistas de datos disponibles en tu cuenta de CJA.
Ejemplo: listar vistas de datos
Endpoint:
GET https://cja.adobe.io/data/dataviews
Cabeceras:
x-api-key: {API_KEY}
x-gw-ims-org-id: {IMS_ORG_ID}
Autorización: 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 "Autorización: Bearer {AUTHORIZATION_TOKEN}"
También puede probar estas solicitudes en la documentación del endpoint de la API de CJA usando la función Probar. Aquí tiene el enlace para probar la solicitud anterior.
Haz clic en el CTA Probar, introduce todos los parámetros obligatorios (en este caso, los parámetros de encabezado que hemos comentado) y pulsa Enviar.
También puedes añadir parámetros adicionales para personalizar tu solicitud. La lista de parámetros disponibles está en la sección Parámetros de consulta de cada solicitud de API en la Documentación de la API de CJA.
Estos son los principales códigos de respuesta HTTP que encontrarás al trabajar con APIs:
- 200: Éxito — El servidor procesó correctamente la solicitud y devolvió datos
- 404: No encontrado — El servidor no pudo encontrar el recurso solicitado
- 500: Error interno del servidor — Se produjo un error en el servidor
Estos códigos de estado indican exactamente qué ha sucedido durante una solicitud de API, lo que facilita la resolución de problemas.
Consejos para quienes usan una API por primera vez
- Verificar el acceso: Asegúrate de tener los niveles de permisos adecuados y de estar incluido en los perfiles de producto correctos. La falta de acceso correcto es la causa más habitual de los fallos en las solicitudes API
- Prueba, prueba, prueba: Utiliza la función Probar en la documentación del endpoint de la API o en Postman para experimentar con solicitudes antes de escribir código.
- Empieza poco a poco: Comienza con peticiones GET sencillas y avanza hacia consultas POST.
- Utiliza la Documentación: La documentación de la API de CJA de Adobe es tu mejor aliada. Consulta periódicamente las actualizaciones, ya que las configuraciones antiguas pueden dejar de funcionar tras grandes cambios.
- Pregunta: No dudes en acudir a la comunidad de Adobe Analytics en Experience League para pedir ayuda.
Empezar con las API de Adobe CJA puede parecer complicado al principio, pero con un poco de práctica, pronto automatizarás flujos de trabajo y descubrirás información valiosa. Da el primer paso: inicia sesión, obtén tus credenciales y haz una llamada API sencilla. ¡Tu aventura con las API comienza ahora!