Introducción para desarrolladores get-started-developers

En esta página: implemente los SDK, el streaming de eventos, los puntos finales de acciones personalizadas y las API que conectan sus aplicaciones a Adobe Journey Optimizer para que sus recorridos puedan ejecutarse en los datos activos.

Como desarrollador, es responsable de implementar e integrar Adobe Journey Optimizer en sus aplicaciones y sistemas. Puede comenzar a trabajar con Adobe Journey Optimizer una vez que la variable Administrador del sistema e Ingeniero de datos le conceda acceso y prepare su entorno.

NOTE
Orden de implementación: AdministradorIngeniero de datos → Usted está aquí: DesarrolladorExperto en marketing
Asegúrese de que los esquemas y eventos de datos estén configurados antes de implementar las integraciones móviles y web.

Su función en el ecosistema de Journey Optimizer

Mientras que otros integrantes del equipo configuran Journey Optimizer a través de la interfaz de usuario, usted se centrará en:

  • Implementación de SDK en aplicaciones móviles y web
  • Envío de eventos desde las aplicaciones para la activación de recorridos
  • Generación de puntos finales de API a los que Journey Optimizer puede llamar mediante acciones personalizadas
  • Integración de Journey Optimizer con sus sistemas e infraestructura existentes
  • Prueba y depuración de sus implementaciones

Su ingeniero de datos se encargará de los esquemas de datos, las configuraciones de eventos y las fuentes de datos. Su administrador configurará permisos y configuraciones de canal. Los expertos en marketing diseñarán los recorridos y el contenido que usan sus implementaciones.

Esta guía describe los pasos esenciales de la implementación técnica para empezar a utilizar Journey Optimizer. Tanto si está creando aplicaciones móviles como experiencias web o integraciones de API, siga las secciones a continuación para configurar su implementación.

Requisitos previos prerequisites

Antes de iniciar la implementación, asegúrese de lo siguiente:

Categoría
Requisitos
Aptitudes técnicas
* Experiencia con JavaScript (para Web SDK) o Swift/Kotlin (para Mobile SDK)
* Comprensión de las API de RESTful y JSON
* Familiaridad con la programación asíncrona y las arquitecturas impulsadas por eventos
* Conocimiento de la arquitectura de aplicaciones de su organización
Acceso y permisos
* Acceso a Adobe Developer Console para credenciales de API
* Entorno de desarrollo con acceso al código base de su aplicación
* Herramientas de prueba como Postman para pruebas de API
* Herramientas para desarrolladores de explorador o herramientas de depuración móvil
De otros integrantes del equipo
* Acceso al entorno concedido por su Administrador
* Esquemas XDM y definiciones de eventos de su Ingeniero de datos
* Requisitos y casos de uso de sus Expertos en marketing

Comprender los fundamentos técnicos technical-foundation

Antes de sumergirse en la implementación, familiarícese con los conceptos técnicos básicos:

  1. Integración de Adobe Experience Platform: Journey Optimizer se ha creado de forma nativa en Adobe Experience Platform. Comprender la arquitectura subyacente le ayudará a crear implementaciones más efectivas. Más información sobre cómo funciona Journey Optimizer.

  2. Modelos de datos XDM: Journey Optimizer utiliza el Modelo de datos de experiencia (XDM) para estructurar los datos de eventos y perfiles. Como desarrollador, tendrá que aprender cómo enviar datos que se ajusten a los esquemas configurados por su ingeniero de datos. Más información acerca de los esquemas XDM.

  3. Autenticación y seguridad: todas las implementaciones requieren la autenticación adecuada. Obtenga información sobre cómo configurar la autenticación para SDK y API. Más información sobre la autenticación de API.

Configurar las integraciones de la aplicación móvil mobile-integration

Configurar el SDK móvil de Adobe Experience Platform

El SDK móvil es una colección de bibliotecas que puede incrustar directamente en la aplicación de iOS o Android. Actúa como la capa de comunicación entre la aplicación y Adobe Experience Platform: identifica a los usuarios, recopila eventos de comportamiento y envía instrucciones desde Journey Optimizer, incluidas notificaciones push, mensajes en la aplicación y contenido personalizado. Sin ella, Journey Optimizer no tiene visibilidad de lo que están haciendo los usuarios de la aplicación ni forma de llegar a ellos.

  1. Instale y configure Mobile SDK: siga la documentación del SDK móvil de Adobe Experience Platform para comenzar a usar la integración de SDK.

  2. Creación de una propiedad móvil: configure una propiedad móvil en Adobe Experience Platform Data Collection. Aprenda a crear y configurar una propiedad móvil.

  3. Configuración de notificaciones push:

    • Para aplicaciones de iOS: registre su aplicación con APNs (servicio de notificaciones push de Apple). Obtenga más información en la documentación de Apple.
    • Para aplicaciones de Android: configure Firebase Cloud Messaging para su aplicación de Android. Obtenga más información en la Documentación de Google.
  4. Pruebe su integración móvil: Use el flujo de trabajo de inicio rápido de la incorporación móvil para configurar y probar rápidamente su configuración móvil.

Los pasos detallados para configurar las notificaciones push están disponibles en esta página.

Implementación de experiencias basadas en código (SDK móvil)

Las experiencias basadas en código le permiten ofrecer contenido personalizado a cualquier superficie de su aplicación móvil nativa, desde pantallas de incorporación y páginas de detalles de productos hasta banners e indicadores de funcionalidades en la aplicación, sin necesidad de una nueva versión de la aplicación. Utilice el SDK móvil para recuperar y procesar contenido personalizado en tiempo de ejecución, lo que permite a su equipo un control total de la ubicación y la presentación:

  • Siga este tutorial para la implementación del SDK móvil
  • Revise las implementaciones de muestra para iOS y Android

Implementación de experiencias web web-implementation

Configuración del SDK web de Adobe Experience Platform

El SDK web (alloy.js) es una sola biblioteca de JavaScript que reemplaza el mosaico de etiquetas Adobe independientes que el sitio podría necesitar de otro modo. Recopila datos de comportamiento, los transmite a Adobe Experience Platform a través de una secuencia de datos que usted configura y recibe instrucciones de personalización de nuevo, todo en un solo recorrido de red. Una vez implementado, Journey Optimizer puede identificar visitantes, activar recorridos de sus acciones y ofrecer contenido personalizado a sus páginas inmediatamente.

  1. Instale el SDK web: siga la guía de implementación del SDK web para configurar el SDK en su sitio web.

  2. Configure secuencias de datos: cree y configure una secuencia de datos en Adobe Experience Platform Data Collection con Journey Optimizer habilitado. Obtenga más información en la documentación de secuencias de datos.

  3. Habilitar notificaciones push web (opcional): las notificaciones push web ya están disponibles de forma general. Configure la propiedad pushNotifications en la configuración de su SDK web y utilice el comando sendPushSubscription para registrar suscripciones push. Más información acerca de la configuración de las notificaciones push web.

Implementar experiencias basadas en código (Web SDK)

A diferencia de los canales visuales, donde los expertos en marketing controlan el diseño por completo, las experiencias basadas en código le proporcionan la propiedad total de cómo se procesa el contenido personalizado en la página. Journey Optimizer devuelve una carga útil JSON con los datos de personalización; su código decide dónde y cómo mostrarla. Este modelo funciona para cualquier superficie web (banners principales, carruseles de recomendaciones, clasificaciones de resultados de búsqueda y variantes de prueba A/B) sin necesidad de un editor visual o un flujo de trabajo de publicación de páginas.

  1. Elija su método de implementación: del lado del cliente, del lado del servidor o híbrido. Revise ejemplos de implementación para cada enfoque.

  2. Defina superficies: identifique las ubicaciones de la aplicación en las que desea enviar contenido personalizado. Más información sobre la configuración de superficie.

  3. Implemente el renderizado de contenido: utilice el SDK web para recuperar y aplicar contenido de personalización. Vea tutoriales de implementación basados en código.

  4. Envío de eventos de visualización e interacción: realice un seguimiento de cuándo se muestra el contenido y cuándo los usuarios interactúan con él para realizar análisis y optimización.

Explore implementaciones de muestra en GitHub para ver las experiencias basadas en código en acción.

Más información sobre cómo empezar a usar las experiencias basadas en código.

Implementación de streaming de eventos event-streaming

Envío de eventos para la activación de recorridos

Recorridos que se ejecutan en eventos: un usuario inicia sesión, añade un elemento al carro de compras, completa una compra y abandona un formulario. Su trabajo consiste en emitir esos eventos desde su aplicación en el momento justo. Cada evento es una carga útil JSON estructurada por XDM enviada a la API de ingesta de streaming de Experience Platform; Journey Optimizer la recoge en milisegundos y enruta el perfil a cualquier recorrido coincidente. El esquema de eventos y la estructura de carga útil están definidos por el ingeniero de datos; coordínese con él antes de empezar a programar.

  1. Conozca la carga útil del evento: colabore con su ingeniero de datos para obtener el esquema de evento y la estructura de carga útil necesaria. La carga útil debe ajustarse al esquema XDM que él ha configurado. Obtenga información acerca de requisitos de esquema de eventos.

  2. Implementar streaming de eventos: envíe eventos a Adobe Experience Platform mediante las API de ingesta de streaming. Conozca los pasos para enviar eventos.

  3. Gestión de tipos de eventos:

    • Eventos unitarios: implemente el envío de eventos para acciones específicas de la persona (por ejemplo, clic en el botón, finalización de la compra).
    • Eventos empresariales: envíe eventos empresariales (por ejemplo, actualizaciones de inventario o cambios de precio)
  4. Envío de eventos de prueba: compruebe que los eventos se reciben correctamente y que activan recorridos según lo esperado. Más información sobre la solución de problemas de eventos.

Implementación de ejemplo para enviar un evento a través de API:

POST https://{DATACOLLECTION_ENDPOINT}/collection/{DATASTREAM_ID}
Content-Type: application/json

{
  "header": {
    "datasetId": "{DATASET_ID}",
    "imsOrgId": "{ORG_ID}",
    "source": {
      "name": "Web SDK"
    }
  },
  "body": {
    "xdmMeta": {
      "schemaRef": {
        "id": "{SCHEMA_ID}"
      }
    },
    "xdmEntity": {
      "_id": "unique-event-id",
      "eventType": "purchase",
      "timestamp": "2024-01-01T12:00:00Z",
      // ... your event data
    }
  }
}

Más información acerca de cómo trabajar con eventos de recorrido.

Desarrollar puntos finales de acción personalizados custom-actions

Cuando un recorrido alcanza un paso de acción personalizada, Journey Optimizer realiza una llamada HTTP saliente a una URL que proporcione: su backend, un programa de administración de la relación con los clientes, una plataforma de lealtad, cualquier punto final REST. Su trabajo consiste en crear y exponer ese punto final: definir el contrato de solicitud (forma de carga útil, método de autenticación, formato de respuesta), implementar la lógica empresarial subyacente y asegurarse de que puede gestionar el volumen de llamadas que generará Journey Optimizer. A continuación, el administrador registra el punto final en Journey Optimizer para que los especialistas en marketing puedan utilizarlo como un paso en sus recorridos.

  1. Cree su punto final de API: cree puntos finales de API RESTful a los que Journey Optimizer llamará durante la ejecución del recorrido. Su punto final debe:

    • Aceptar cargas útiles JSON
    • Autenticar solicitudes (OAuth, clave de API o JWT)
    • Procesar solicitudes dentro de los límites de tiempo de espera adecuados
    • Devolver respuestas en el formato esperado
  2. Conozca las capacidades de acción personalizadas: las acciones personalizadas pueden conectarse a sistemas de terceros como Epsilon, Slack, Firebase o a sus propios servicios. Más información sobre las acciones personalizadas.

  3. Trabaje con configuraciones de acción: Su administrador o ingeniero de datos configurará la acción personalizada en Journey Optimizer, definiendo la dirección URL del punto final de API, el método de autenticación y los parámetros. Les proporcionará su especificación de API. Obtenga información sobre la configuración de acciones personalizadas. Puede definir una carga útil de respuesta de error opcional para una lógica de reserva más completa en las ramas de tiempo de espera/error.

  4. Devolver datos procesables: diseñe su API para devolver datos que se puedan usar en pasos de recorrido posteriores. Obtenga información acerca de respuestas de acción.

  5. Monitorizar el estado de las acciones personalizadas: use el panel de monitorización de acciones personalizadas para rastrear las llamadas, los errores, el rendimiento, los tiempos de respuesta y los tiempos de espera de cola correctos. Obtenga información sobre la creación informes de acciones personalizadas.

  6. Implemente limitación de velocidad: asegúrese de que los puntos finales puedan asumir el volumen esperado. Journey Optimizer aplica un límite de 5000 llamadas/segundo, pero el sistema debe ser flexible. Obtenga información sobre límite y regulación.

Ejemplo de caso de uso: escritura de eventos de recorrido en Experience Platform mediante acciones personalizadas.

Trabajo con las API de Journey Optimizer apis

No es necesario que todo ocurra a través de la interfaz de usuario de Journey Optimizer. A veces, debe activar una campaña desde su propio backend, suprimir una dirección de correo electrónico después de una solicitud de privacidad o sincronizar plantillas de contenido desde un CMS externo. Las API de REST de Journey Optimizer le proporcionan acceso mediante programación a las funciones principales de la plataforma. Todas las llamadas utilizan la autenticación de servidor a servidor OAuth (el método JWT más antiguo está obsoleto).

  1. Comprenda las capacidades de la API: las API de Journey Optimizer le permiten crear, leer, actualizar y eliminar varios recursos mediante programación. Más información sobre las API de Journey Optimizer.

  2. Autenticación: siga este tutorial para configurar la autenticación de API mediante Adobe Developer Console.

  3. Explore referencias de API: examine la documentación completa de la API y pruebe las API directamente en la referencia de la API de Adobe Journey Optimizer.

  4. Campañas activadas por API: cree mensajería transaccional con campañas activadas por API. Para escenarios de gran volumen (hasta 5000 TPS), explore el Modo de alto rendimiento (requiere licencia adicional).

  5. API de gestión de decisiones: use API especializadas para la gestión y toma de decisiones de ofertas. Obtenga más información en la Guía de API de gestión de decisiones.

  6. API de migración de decisiones: migre mediante programación las entidades de Gestión de decisiones a Toma de decisiones con ámbitos flexibles, validación automatizada y compatibilidad con reversiones. Obtenga más información en la Guía de API de migración de toma de decisiones.

  7. Webhooks de SMS: configure los webhooks entrantes para capturar los mensajes entrantes y los webhooks de comentarios para recibir confirmaciones de envío y actualizaciones de estado. Más información.

Pruebas y depuración testing

Antes de que la implementación se inicie, debe confiar en que los eventos se desencadenen en el momento adecuado, los recorridos se activen según lo esperado, las acciones personalizadas se comporten bajo una carga realista y el contenido personalizado se procese correctamente. Esta sección cubre las herramientas y técnicas para detectar problemas de forma temprana, desde el registro de SDK de bajo nivel hasta las ejecuciones de pruebas de recorrido de extremo a extremo con perfiles reales.

  1. Implementación de SDK de depuración: use Adobe Experience Platform Assurance para inspeccionar eventos de SDK, validar la recopilación de datos y solucionar problemas de integración a medida que se produzcan. Obtenga más información sobre Assurance.

  2. Envío de eventos de prueba: verifique que los eventos de su aplicación son recibidos correctamente por Adobe Experience Platform y activan los recorridos según lo previsto. Monitorice la ingesta de eventos y valide la estructura de carga útil.

  3. Validar integraciones de API: pruebe los puntos finales de acción personalizados para asegurarse de que administran correctamente las solicitudes de Journey Optimizer, responden dentro de los límites de tiempo de espera y devuelven los formatos de datos esperados.

  4. Use el modo de prueba con perfiles de prueba: trabaje con su ingeniero de datos para obtener acceso a los perfiles de prueba y, a continuación, valide su implementación mediante el modo de prueba de recorrido. Aprenda a probar recorridos.

  5. Monitorice los registros de SDK: habilite el registro de depuración en la implementación de SDK para solucionar problemas durante el desarrollo:

    • SDK móvil: habilite el registro para ver eventos de SDK y llamadas a la API
    • Web SDK: utilice la consola del explorador para monitorizar la actividad de SDK
  6. Verifique la configuración de la secuencia de datos: asegúrese de que la secuencia de datos esté configurada correctamente para enviar datos a Journey Optimizer. Compruebe que los eventos fluyen a través de la secuencia de datos hasta los destinos correctos.

  7. Consulte datos de recorrido para el análisis: use consultas SQL en el lago de datos para analizar eventos de pasos de recorrido, depurar problemas y monitorizar el rendimiento de acciones personalizadas. Explore ejemplos de consultas para el análisis de recorrido, incluidos:

    • Razones de entrada/salida del perfil y de descarte
    • Métricas de rendimiento de acciones personalizadas (latencia, rendimiento, errores)
    • Envío de eventos y patrones de error
    • Estados de instancias de recorrido

Temas avanzados para desarrolladores advanced-topics

Una vez que los SDK, los eventos y las API principales estén implementados, estos temas le ayudan a ir más allá: enriquecimiento de los datos de recorrido en tiempo de ejecución sin sobrecargar el perfil, administración de señales de consentimiento para que las exclusiones se propaguen a través de cada integración y ajuste de la implementación para el rendimiento y la fiabilidad que exige la escala de producción.

Uso de datos contextuales y enriquecimiento

Los recorridos suelen necesitar más datos que los que llegan en el evento de activación: un nombre de producto, un nivel de lealtad y una lista de elementos de línea de pedido. En lugar de precargar todo esto en cada perfil, el enriquecimiento contextual permite que el recorrido lo busque en tiempo de ejecución desde conjuntos de datos de AEP o lo transfiera desde una respuesta de acción personalizada. Los mensajes y las condiciones de las ramas pueden hacer referencia a esos datos sin que se almacenen de forma permanente en el perfil.

  • Iterar en matrices: use la sintaxis de Handlebars para mostrar listas dinámicas de eventos, respuestas de acciones personalizadas y búsquedas de conjuntos de datos en mensajes. Obtenga información acerca de iteración de datos contextuales.
  • Búsqueda de conjuntos de datos: implemente búsquedas de conjuntos de datos para enriquecer los datos de recorrido de los conjuntos de datos de Adobe Experience Platform. Trabaje con su ingeniero de datos en la configuración. Obtenga información acerca de búsqueda de conjuntos de datos.

Uso del consentimiento y la gobernanza

Journey Optimizer aplica las directivas de consentimiento y gobernanza de datos en el nivel de plataforma, pero la integración también debe respetarlas. Cuando un cliente decide excluirse de las comunicaciones de marketing o cuando una etiqueta de uso de datos restringe cómo se puede utilizar un campo, esas reglas deben propagarse a través de las acciones personalizadas y las búsquedas de conjuntos de datos, no solo bloquear las acciones en la interfaz de usuario.

  • Gobernanza de datos: aplique directivas de uso de datos a las acciones personalizadas. Más información sobre la gobernanza de los datos.
  • Gestión del consentimiento: administre las preferencias de consentimiento del cliente en sus implementaciones. Más información sobre el consentimiento.

Optimización y prácticas recomendadas

Las implementaciones de producción de Journey Optimizer administran con regularidad millones de eventos y miles de ejecuciones de recorrido por segundo. Estos recursos le ayudan a ajustar la integración para esa escala: comprenda los límites de tasa antes de alcanzarlos, evite los escollos comunes del diseño de recorridos que pierden perfiles en silencio y genere un control de errores que se degrade de forma controlada, en lugar de fallar de manera opaca.

Llamada a las API de REST de Journey Optimizer rest-apis

Además de implementar los SDK y el streaming de eventos, también puede dirigir Journey Optimizer mediante programación desde sus propios sistemas. La referencia de la API completa, las especificaciones de OpenAPI y las muestras de código se encuentran en el Portal del desarrollador de Journey Optimizer.

NOTE
Todas las integraciones deben utilizar la autenticación de servidor a servidor OAuth (el método JWT está obsoleto). Configuración de la autenticación

Ejecución de campañas activadas mediante API api-triggered

Active mensajes transaccionales o de marketing de un sistema externo mediante la API de REST de ejecución de mensajes interactivos. Antes de llamar al punto final:

  • La campaña debe estar activada antes de que el punto final acepte llamadas.
  • Las llamadas tienen un tiempo de espera de 60 segundos; los reintentos internos controlan los tiempos de espera inesperados.
  • Si se configuran las fechas de inicio y finalización de la campaña, las llamadas a la API fuera de esas fechas fallarán.
  • Para crear su carga útil, recupere la solicitud cURL de muestra generada desde la sección solicitud cURL de su campaña activa en la interfaz de usuario de Journey Optimizer; esta incluye todas las variables de personalización para esa campaña.
  • Las campañas estándar y de alto rendimiento usan puntos finales diferentes.

Referencia de la API · Muestras de código · Trabajo con campañas activadas por API

Límite y restricción para puntos finales externos capping-throttling

Cuando los recorridos llaman a sistemas externos mediante acciones personalizadas o fuentes de datos, las API de restricción y límite protegen esos sistemas de la sobrecarga. El límite rechaza las llamadas que superan el límite configurado; la restricción las pone en cola durante un máximo de seis horas (solo zonas protegidas de producción y acciones personalizadas).

Referencia de la API de límite · Trabajo con la API de límite · Trabajo con la API de restricción

Más API de REST more-rest-apis

Más allá de la mensajería y el límite, Journey Optimizer expone los puntos finales REST para la administración de supresión, la creación de plantillas de contenido, la recuperación de campañas, la revisión y la ejecución de campañas orquestadas. Utilícelos cuando necesite automatizar operaciones que, de lo contrario, requerirían pasos manuales en la interfaz de usuario, como la supresión masiva de direcciones después de una extracción de datos o la sincronización de plantillas de una canalización de contenido externo.

Qué debe hacer
Referencia de la API
Excluir direcciones de correo electrónico o dominios del envío mediante programación
API de supresión · Administración de la lista de supresión
Recupere los metadatos del recorrido para auditorías o sincronizaciones externas
API de recorridos
Cree y administre plantillas y fragmentos de contenido desde una canalización externa
API de contenido · Plantillas · Fragmentos
Recupere y filtre campañas de acción
API de campañas
Previsualice campañas y envíe pruebas mediante programación
API de simulaciones
NOTE
La API de simulaciones está disponible para campañas de acción (programadas) y activadas por API. No es compatible con campañas orquestadas: en su lugar, use el flujo de trabajo de previsualización y prueba en la interfaz de usuario de las campañas orquestadas.

| Validación de conjuntos de datos y activación de la ejecución de campañas orquestadas | Validación de conjuntos de datos · Activación · Habilitación de conjuntos de datos |

Recursos adicionales additional-resources

Colaboración entre funciones next-steps

El trabajo de implementación se intersecta con otros integrantes del equipo:

Trabajo con ingenieros de datos

Colabore con los ingenieros de datos en las configuraciones de datos y eventos. Cada recorrido que reacciona al comportamiento del usuario depende de los eventos que envía; el ingeniero de datos define los esquemas, usted implementa el código que los produce.

  • Obtenga los esquemas XDM y las estructuras de eventos que debe implementar
  • Aprenda qué eventos debe enviar y su formato de carga útil requerido (vea Trabajo con eventos de recorrido)
  • Confirme qué campos son obligatorios y cuáles son opcionales en cada carga útil de evento y qué sucede en los recorridos cuando faltan campos esperados o tienen un formato incorrecto (vea Requisitos de esquema)
  • Pruebe el envío de eventos y la ingesta de datos juntos usando Adobe Experience Platform Assurance
Trabaje con los administradores

Colabore con los administradores en las configuraciones de acceso y canal. Los recorridos solo pueden llegar a los usuarios a través de los canales que el administrador haya configurado. Coordínelos antes para que el trabajo del SDK y su configuración estén sincronizados.

Trabaje con los expertos en marketing

Colabore con los expertos en marketing en el diseño y en las pruebas del recorrido. Los expertos en marketing crean recorridos y contenido que dependen totalmente de los eventos que envía y de las superficies que expone; cuanto más se ajusten a ellos, más rápido se activarán los recorridos.

Comenzar la implementación

¿Listo para comenzar a crear? Elija su primera área de implementación en las secciones anteriores:

  1. ¿Aplicación móvil? Comience con integración de SDK móvil
  2. ¿Sitio web? Comience con Configuración de Web SDK
  3. ¿Integración de API? Vaya a Trabajar con API
  4. ¿Sistema personalizado? Consulte Acciones personalizadas

Cada sección incluye vínculos a documentación técnica detallada, ejemplos de código y tutoriales que guiarán la implementación.

Otras guías de funciones other-role-guides

Volver a Información general sobre funciones y responsabilidades · Volver a Introducción

AI Knowledge Reference

This section contains structured knowledge intended to support interpretation, retrieval, and question answering related to this topic.

For complete understanding, this information should be combined with the documentation on this page. Neither source is intended to stand alone; the page describes the feature, while this section provides additional context that helps disambiguate terminology, intent, applicability, and constraints.

  • TL;DR: This page is the Developer getting-started path, covering how to implement the Mobile and Web SDKs, event streaming, custom action endpoints, and Journey Optimizer REST APIs, then test and debug those integrations.

Intents:

  • Set up Adobe Experience Platform Mobile SDK and Web SDK integrations
  • Implement code-based experiences for mobile and web surfaces
  • Send events to trigger journeys using the Streaming Ingestion APIs
  • Develop custom action endpoints that Journey Optimizer calls during journey execution
  • Work with Journey Optimizer REST APIs, including API-triggered campaigns and capping and throttling
  • Test and debug implementations using test mode with test profiles and Adobe Experience Platform Assurance

Glossary:

  • Mobile SDK: A collection of libraries embedded in an iOS or Android app that identifies users, collects behavioral events, and delivers instructions from Journey Optimizer (product-specific)
  • Web SDK (alloy.js): A single JavaScript library that collects behavioral data, streams it to Adobe Experience Platform through a datastream, and receives personalization instructions back (product-specific)
  • Custom action: A journey step where Journey Optimizer makes an outbound HTTP call to a URL you provide, such as a backend, CRM, or loyalty platform (product-specific)
  • Code-based experiences: Personalized content delivered to any mobile or web surface, where Journey Optimizer returns a JSON payload and your code decides where and how to display it (product-specific)
  • Unitary events: Person-specific action events (for example a button click or purchase completion), as distinct from business events such as inventory updates or price changes (product-specific)

Guardrails:

  • Journey Optimizer applies a 5000 calls/second limit for custom action endpoints, but your system should be resilient.
  • API-triggered campaign calls have a timeout of 60 seconds; internal retries handle unexpected timeouts.
  • An API-triggered campaign must be activated before the endpoint accepts calls, and calls made outside configured campaign start and end dates will fail.
  • Throttling queues calls for up to 6 hours (production sandboxes, custom actions only), while capping rejects calls that exceed the configured limit.
  • High Throughput mode for API-triggered campaigns supports up to 5000 TPS and requires an add-on license.
  • All integrations must use OAuth Server-to-Server authentication; the JWT method is deprecated.
  • The Simulations API is available for API-triggered and Action (scheduled) campaigns and is not supported for Orchestrated campaigns.

Terminology:

  • Canonical name: Developer — variants: Developer getting-started path
  • Acronyms: SDK = Software Development Kit; XDM = Adobe Experience Data Model; TPS = transactions per second; API = Application Programming Interface
  • Implementation order: Administrator → Data Engineer → Developer → Marketer
  • Do not confuse: “Mobile SDK” (embedded iOS or Android libraries) ≠ “Web SDK” (alloy.js JavaScript library)
  • Do not confuse: “Capping” (rejects calls that exceed the configured limit) ≠ “Throttling” (queues calls for up to 6 hours)

FAQ:

  • Q: What is the rate limit for custom action endpoints? — Journey Optimizer applies a 5000 calls/second limit, but your endpoints should still be resilient.
  • Q: Which authentication method must API integrations use? — OAuth Server-to-Server authentication; the JWT method is deprecated.
  • Q: What must be true before an API-triggered campaign endpoint accepts calls? — The campaign must be activated, and calls outside any configured start and end dates will fail.
  • Q: What is the difference between capping and throttling? — Capping rejects calls that exceed the configured limit, while throttling queues them for up to 6 hours (production sandboxes, custom actions only).
  • Q: Is the Simulations API supported for Orchestrated campaigns? — No; it is available for API-triggered and Action (scheduled) campaigns, and you use the preview and proof workflow in the Orchestrated campaigns user interface instead.
  • Q: How do I test my implementation before it goes live? — Use test mode with test profiles obtained from your Data Engineer, and use Adobe Experience Platform Assurance to inspect SDK events and troubleshoot.
recommendation-more-help
journey-optimizer-help