Introdução para desenvolvedores get-started-developers

Nesta página: implemente os SDKs, o streaming de eventos, os pontos de acesso de ações personalizadas e as APIs que conectam seus aplicativos ao Adobe Journey Optimizer, para que suas jornadas possam ser executadas com dados em tempo real.

Como desenvolvedor(a), você é responsável pela implementação e integração do Adobe Journey Optimizer nos aplicativos e sistemas. É possível começar a trabalhar com o Adobe Journey Optimizer assim que o(a) admin de sistema e o(a) engenheiro(a) de dados concederem acesso e prepararem o ambiente.

NOTE
Ordem de implementação: AdministradorEngenheiro de dados → Você está aqui: DesenvolvedorProfissional de marketing
Verifique se esquemas de dados e eventos estão configurados antes de implementar suas integrações móveis e da Web.

Sua função no ecossistema do Journey Optimizer

Enquanto outros membros da equipe configuram o Journey Optimizer por meio da interface, você se concentrará em:

  • Implementar SDKs em aplicativos para dispositivos móveis e web
  • Enviar eventos a partir dos aplicativos para acionar jornadas
  • Criar pontos de acesso de API que o Journey Optimizer pode chamar por meio de ações personalizadas
  • Integrar o Journey Optimizer aos sistemas e infraestrutura existentes
  • Testar e depurar implementações

O Engenheiro de dados manipulará esquemas de dados, configurações de eventos e fontes de dados. O Admin definirá as permissões e as configurações de canal. Os profissionais de marketing criarão as jornadas e o conteúdo que usa as implementações.

Este guia aborda as etapas essenciais de implementação técnica para uma introdução ao Journey Optimizer. Se estiver criando aplicativos para dispositivos móveis, experiências da web ou integrações de API, siga as seções abaixo para configurar a implementação.

Pré-requisitos prerequisites

Antes de iniciar a implementação, verifique se possui:

Categoria
Exigências
Competências técnicas
* Experiência com JavaScript (para SDK da web) ou Swift/Kotlin (SDK para dispositivos móveis)
* Noções básicas sobre APIs RESTful e JSON
* Familiaridade com programação assíncrona e arquiteturas orientadas por eventos
* Conhecimento da arquitetura de aplicativos da organização
Acesso e ferramentas
* Acesso ao Adobe Developer Console para credenciais de API
* Ambiente de desenvolvimento com acesso à base do código do aplicativo
* Ferramentas de teste como o Postman para teste de API
* Ferramentas de desenvolvedor do navegador ou ferramentas de depuração para dispositivos móveis
De outros membros da equipe
* Concessão de acesso ao ambiente pelos esquemas XDM do Admin
* e definições de evento do Engenheiro de dados
* Requisitos e casos de uso dos Profissionais de marketing

Compreender as bases técnicas technical-foundation

Antes de se aprofundar na implementação, familiarize-se com os conceitos técnicos principais:

  1. Integração da Adobe Experience Platform: o Journey Optimizer foi criado nativamente na Adobe Experience Platform. Compreender a arquitetura subjacente ajudará a criar implementações mais eficazes. Saiba mais sobre como o Journey Optimizer funciona.

  2. Modelos de dados XDM: o Journey Optimizer usa o Experience Data Model (XDM) para estruturar dados de evento e perfil. Como desenvolvedor(a), será necessário entender como enviar dados que estejam em conformidade com os esquemas configurados pelo Engenheiro de dados. Saiba mais sobre esquemas XDM.

  3. Autenticação e segurança: todas as implementações exigem autenticação adequada. Entenda como configurar a autenticação para SDKs e APIs. Saiba mais sobre Autenticação de API.

Configurar integrações de aplicativos para dispositivos móveis mobile-integration

Configurar o SDK para dispositivos móveis da Adobe Experience Platform

O SDK móvel é uma coleção de bibliotecas incorporadas diretamente no aplicativo iOS ou Android. Ele age como a camada de comunicação entre o aplicativo e a Adobe Experience Platform: identifica usuários, coleta eventos comportamentais e fornece instruções do Journey Optimizer, incluindo notificações por push, mensagens no aplicativo e conteúdo personalizado. Sem ele, o Journey Optimizer não tem visibilidade do que os usuários do aplicativo estão fazendo nem como acessá-los.

  1. Instalar e configurar o SDK para dispositivos móveis: siga a documentação do SDK para dispositivos móveis da Adobe Experience Platform para ver uma introdução à integração do SDK.

  2. Criar uma propriedade móvel: configure uma propriedade móvel na Adobe Experience Platform Data Collection. Saiba como criar e configurar uma propriedade móvel.

  3. Configurar notificações por push:

    • Para aplicativos iOS: registre o aplicativo com APNs (serviço de notificação por push da Apple). Saiba mais na documentação da Apple.
    • Para aplicativos Android: configure o Firebase Cloud Messaging para seu aplicativo Android. Saiba mais na documentação do Google.
  4. Testar a integração móvel: use o fluxo de trabalho de início rápido da integração para dispositivos móveis para definir e testar rapidamente a configuração para dispositivos móveis.

As etapas detalhadas para configurar notificações por push estão disponíveis nesta página.

Implementar experiências baseadas em código (SDK para dispositivos móveis)

Experiências baseadas em código permitem fornecer conteúdo personalizado a qualquer superfície em seu aplicativo móvel nativo, desde telas de integração e páginas de detalhes do produto até banners no aplicativo e sinalizadores de recursos, sem exigir uma nova versão do aplicativo. Use o SDK móvel para buscar e renderizar conteúdo personalizado no tempo de execução, dando à sua equipe controle total sobre o posicionamento e a apresentação:

  • Siga este tutorial para a implementação do SDK para dispositivos móveis
  • Revise as implementações de exemplo do iOS e do Android

Implementar experiências da web web-implementation

Configurar o SDK da web da Adobe Experience Platform

O SDK da web (alloy.js) é uma única biblioteca JavaScript que substitui o conjunto fragmentado de tags separadas da Adobe de que seu site poderia precisar. Ele coleta dados comportamentais, transmite-os para a Adobe Experience Platform por meio de uma sequência de dados configurada por você e recebe instruções de personalização de volta — tudo em uma única ida e volta pela rede. Uma vez implementado, o Journey Optimizer pode identificar visitantes, acionar jornadas de suas ações e fornecer conteúdo personalizado para suas páginas imediatamente.

  1. Instalar o SDK da web: siga o guia de implementação do SDK da web para configurar o SDK no site.

  2. Configurar sequências de dados: crie e configure uma sequência de dados na Adobe Experience Platform Data Collection com o Journey Optimizer habilitado. Saiba mais na documentação das sequências de dados.

  3. Habilitar notificações por push da Web (opcional): as notificações por push da Web agora estão disponíveis. Configure a propriedade pushNotifications na configuração do SDK da Web e use o comando sendPushSubscription para registrar assinaturas por push. Saiba mais sobre a configuração de push da Web.

Implementar experiências baseadas em código (SDK da web)

Diferentemente dos canais visuais, em que os profissionais de marketing controlam totalmente o layout, as experiências baseadas em código fornecem total propriedade sobre como o conteúdo personalizado é renderizado na página. O Journey Optimizer retorna um conteúdo JSON com os dados de personalização; o código decide onde e como exibi-lo. Esse modelo funciona para qualquer superfície da Web — banners ilustrados, carrosséis de recomendação, classificações de resultados de pesquisa, variantes de teste A/B — sem precisar de um editor visual ou fluxo de trabalho de publicação de página.

  1. Escolha o método de implementação: lado do cliente, lado do servidor ou híbrido. Revise os exemplos de implementação para cada abordagem.

  2. Definir superfícies: identifique os locais no aplicativo em que deseja fornecer conteúdo personalizado. Saiba mais sobre a configuração da superfície.

  3. Implementar renderização de conteúdo: use o SDK da web para buscar e aplicar conteúdo de personalização. Consulte tutoriais de implementação baseados em código.

  4. Enviar eventos de exibição e interação: controle quando o conteúdo é exibido e quando os usuários interagem com ele para fins de análise e otimização.

Explore implementações de exemplo no GitHub para ver as experiências baseadas em código em ação.

Saiba mais sobre a introdução a experiências baseadas em código.

Implementar a transmissão de eventos event-streaming

Enviar eventos para acionar jornadas

Jornadas executadas em eventos: um usuário faz logon, adiciona um item ao carrinho, conclui uma compra, abandona um formulário. Seu trabalho é emitir esses eventos do seu aplicativo no momento exato. Cada evento é um conteúdo JSON estruturada em XDM enviado para a API de ingestão de transmissão da Experience Platform; o Journey Optimizer o seleciona em milissegundos e direciona o perfil para qualquer jornada correspondente. O esquema de evento e a estrutura de conteúdo são definidos pelo seu Engenheiro de dados — coordene com ele antes de começar a codificar.

  1. Entender o conteúdo do evento: trabalhe com o Engenheiro de dados para obter o esquema do evento e a estrutura de conteúdo necessária. O conteúdo deve estar em conformidade com o esquema XDM configurado. Saiba mais sobre os requisitos do esquema de evento.

  2. Implementar a transmissão de eventos: envie eventos para a Adobe Experience Platform usando as APIs de ingestão de transmissão. Saiba mais sobre as etapas para enviar eventos.

  3. Tipos de evento de processamento:

    • Eventos unitários: implementam o envio de eventos para ações específicas de pessoas (por exemplo: clique de botão, conclusão de compra)
    • Eventos de negócios: enviar eventos relacionados a negócios (por exemplo: atualizações de estoque, alterações de preço)
  4. Entrega de evento de teste: verifica se os eventos são recebidos corretamente e acionam as jornadas conforme o esperado. Saiba mais sobre a solução de problemas de eventos.

Exemplo de implementação para enviar um evento via 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
    }
  }
}

Saiba mais sobre como trabalhar com eventos de jornada.

Desenvolver pontos de acesso de ações personalizadas custom-actions

Quando uma jornada atinge uma etapa de ação personalizada, o Journey Optimizer faz uma chamada HTTP de saída para um URL que você fornece — seu back-end, um CRM, uma plataforma de fidelidade, qualquer ponto de acesso REST. Seu trabalho é criar e expor esse ponto de acesso: defina o contrato de solicitação (forma de conteúdo, método de autenticação, formato de resposta), implemente a lógica de negócios por trás dele e garanta que ele possa lidar com o volume de chamadas gerado pelo Journey Optimizer. O Administrador registra o ponto de acesso no Journey Optimizer para que os profissionais de marketing possam usá-lo como uma etapa em suas jornadas.

  1. Criar ponto de acesso de API: crie pontos de acesso da API RESTful que o Journey Optimizer chamará durante a execução da jornada. Seu ponto de acesso deve:

    • Aceitar conteúdos JSON
    • Autenticar solicitações (OAuth, chave de API ou JWT)
    • Processar solicitações dentro dos limites de tempo apropriados
    • Retornar respostas no formato esperado
  2. Entenda os recursos das ações personalizadas: as ações personalizadas podem se conectar a sistemas de terceiros, como Epsilon, Slack, Firebase ou os seus próprios serviços. Saiba mais sobre ações personalizadas.

  3. Trabalhar com configurações de ação: o Admin ou o Engenheiro de dados configurará a ação personalizada no Journey Optimizer, definindo a URL do ponto de acesso da API, o método de autenticação e os parâmetros. Você fornecerá a eles a especificação da API. Saiba mais sobre a configuração da ação personalizada. Você pode definir um conteúdo de resposta a erros opcional para uma lógica de fallback mais avançada em ramificações de tempo limite/erro.

  4. Retornar dados acionáveis: crie a API para retornar dados que possam ser usados nas etapas seguintes da jornada. Saiba mais sobre as respostas de ação.

  5. Monitorar a integridade da ação personalizada: use o painel de monitoramento da ação personalizada para rastrear chamadas bem-sucedidas, erros, taxa de transferência, tempos de resposta e tempos de espera em fila. Saiba mais sobre relatórios de ações personalizadas.

  6. Implementar a limitação de taxa: certifique-se de que os pontos de acesso possam lidar com o volume esperado. O Journey Optimizer aplica um limite de 5000 chamadas/segundo, mas o sistema deve ser resiliente. Saiba mais sobre limitação e controle.

Caso de uso de exemplo: gravação de eventos da jornada na Experience Platform usando ações personalizadas.

Trabalhar com APIs do Journey Optimizer apis

Nem tudo precisa acontecer por meio da interface do Journey Optimizer. Às vezes, você precisa acionar uma campanha do seu próprio back-end, suprimir um endereço de email após uma solicitação de privacidade ou sincronizar modelos de conteúdo de um CMS externo. As REST APIs do Journey Optimizer fornecem acesso programático aos principais recursos da plataforma. Todas as chamadas usam a autenticação de servidor para servidor OAuth; o método JWT mais antigo foi descontinuado.

  1. Entender os recursos da API: as APIs do Journey Optimizer permitem criar, ler, atualizar e excluir vários recursos de forma programática. Saiba mais sobre as APIs do Journey Optimizer.

  2. Autenticação: siga este tutorial para configurar a autenticação de API com o Adobe Developer Console.

  3. Explorar referências de API: navegue pela documentação completa da API e experimente APIs diretamente na Referência da API do Adobe Journey Optimizer.

  4. Campanhas acionadas por API: crie mensagens transacionais com campanhas acionadas por API. Para cenários com alto volume (até 5000 TPS), explore o modo de Alta taxa de transferência (requer licença complementar).

  5. APIs de Gestão de decisões: use APIs especializadas para gerenciamento de ofertas e decisioning. Saiba mais no Guia da API de Gestão de Decisões.

  6. APIs de migração de decisão: migre programaticamente entidades de Gestão de decisões para a Decisão com escopos flexíveis, validação automatizada e suporte de reversão. Saiba mais no Guia da API de migração de decisão.

  7. Webhooks de SMS: configure webhooks de entrada para capturar mensagens de entrada e webhooks de feedback para receber confirmações de entrega e atualizações de status. Saiba mais.

Teste e depuração testing

Antes da implementação entrar em vigor, você precisa ter certeza de que os eventos são acionados no momento certo, as jornadas são acionadas conforme esperado, as ações personalizadas se comportam sob carga realista e o conteúdo personalizado é renderizado corretamente. Esta seção aborda as ferramentas e técnicas para detectar problemas antecipadamente, desde o registro do SDK de baixo nível até execuções de testes de jornada de ponta a ponta com perfis reais.

  1. Depurar a implementação do SDK: use o Adobe Experience Platform Assurance para inspecionar eventos do SDK, validar a coleção de dados e solucionar problemas de integração em tempo real. Saiba mais sobre o Assurance.

  2. Entrega de evento de teste: verifica se os eventos do aplicativo são recebidos corretamente pela Adobe Experience Platform e acionam jornadas conforme o esperado. Monitore a ingestão de eventos e valide a estrutura do conteúdo.

  3. Validar integrações de API: teste os pontos de acesso de ações personalizadas para garantir que eles processem corretamente as solicitações do Journey Optimizer, respondam dentro dos limites de tempo e retornem formatos de dados esperados.

  4. Usar o modo de teste com perfis de teste: trabalhe com o Engenheiro de dados para obter acesso aos perfis de teste e validar a implementação com o modo de teste de jornada. Saiba como testar jornadas.

  5. Monitorar logs do SDK: habilite os logs de depuração na implementação do SDK para solucionar problemas durante o desenvolvimento:

    • SDK para dispositivos móveis: habilite logs para ver eventos do SDK e chamadas de API
    • SDK da web: use o console do navegador para monitorar a atividade do SDK
  6. Verificar configuração da sequência de dados: verifique se a sequência de dados está configurada corretamente para enviar dados ao Journey Optimizer. Verifique se os eventos fluem pela sequência de dados para os destinos corretos.

  7. Consultar dados da jornada para análise: use consultas SQL no data lake para analisar eventos de etapa da jornada, depurar problemas e monitorar o desempenho da ação personalizada. Explore exemplos de consulta para análise da jornada incluindo:

    • Rastreamento de entrada/saída de perfil e motivos de descarte
    • Métricas de desempenho de ação personalizada (latência, taxa de transferência, erros)
    • Entrega de eventos e padrões de erro
    • Estados da instância da jornada

Tópicos avançados do desenvolvedor advanced-topics

Quando seus SDKs, eventos e APIs principais estão em vigor, esses tópicos ajudam você a ir além: enriquecer dados da jornada no tempo de execução sem sobrecarregar o perfil, manipular sinais de consentimento para que as recusas se propaguem por todas as integrações e ajustar a implementação para a taxa de transferência e a confiabilidade que a escala de produção exige.

Trabalho com dados contextuais e enriquecimento

As jornadas geralmente precisam de mais dados do que o que chega no evento de acionamento: um nome de produto, um nível de fidelidade, uma lista de itens de linha de pedido. Em vez de pré-carregar tudo isso em cada perfil, o enriquecimento contextual permite que a jornada o procure no tempo de execução dos conjuntos de dados da AEP ou o carregue a partir de uma resposta de ação personalizada. Suas mensagens e condições de ramificação podem fazer referência a esses dados sem que eles sejam armazenados permanentemente no perfil.

  • Iterar em matrizes: use a sintaxe de manipuladores para exibir listas dinâmicas de eventos, respostas da ação personalizada e pesquisas de conjuntos de dados em mensagens. Saiba mais sobre a iteração de dados contextuais.
  • Pesquisa de conjunto de dados: implemente pesquisas de conjunto de dados para enriquecer os dados da jornada a partir de conjuntos de dados da Adobe Experience Platform. Trabalhe com o(a) engenheiro(a) de dados na configuração. Saiba mais sobre pesquisa de conjunto de dados.

Trabalhar com consentimento e governança

O Journey Optimizer aplica políticas de consentimento e governança de dados no nível da plataforma, mas a integração também precisa respeitá-las. Quando um cliente opta por não receber comunicações de marketing, ou quando um rótulo de uso de dados restringe a forma como um campo pode ser utilizado, essas regras precisam ser propagadas pelas suas ações personalizadas e consultas a conjuntos de dados, não apenas bloquear ações na interface.

  • Governança de dados: aplica políticas de uso de dados a ações personalizadas. Saiba mais sobre a governança de dados.
  • Gerenciamento de consentimento: lida com as preferências de consentimento do cliente nas implementações. Saiba mais sobre consentimento.

Otimização e práticas recomendadas

As implementações de produção do Journey Optimizer lidam regularmente com milhões de eventos e milhares de execuções de jornadas por segundo. Esses recursos ajudam você a ajustar a integração para lidar com essa escala: entender os limites de taxa antes de atingi-los, evitar armadilhas comuns no design de jornadas que podem fazer com que perfis sejam silenciosamente descartados e implementar um tratamento de erros que permita uma degradação gradual, em vez de falhas sem uma causa aparente.

Chamar APIs REST do Journey Optimizer rest-apis

Além de implementar SDKs e o streaming de eventos, você também pode controlar o Journey Optimizer de forma programática a partir dos seus próprios sistemas. A referência completa da API, as especificações da OpenAPI e as amostras de código estão no portal do desenvolvedor do Journey Optimizer.

NOTE
Todas as integrações devem usar a autenticação de servidor para servidor do OAuth; o método JWT foi descontinuado. Configurar autenticação

Executar campanhas acionadas por API api-triggered

Acione mensagens transacionais ou de marketing de um sistema externo usando a API REST de execução de mensagem interativa. Antes de chamar o ponto de acesso:

  • A campanha deve ser ativada antes que o ponto de acesso aceite chamadas.
  • As chamadas têm um tempo limite de 60 segundos; as tentativas internas lidam com tempos limite inesperados.
  • Se as datas de início/término da campanha estão configuradas, as chamadas da API fora dessas datas apresentam falha.
  • Para criar o conteúdo, recupere a solicitação de cURL de amostra gerada na seção solicitação de cURL da campanha em tempo real na interface do Journey Optimizer — ela inclui todas as variáveis de personalização dessa campanha.
  • As campanhas padrão e de alta taxa de transferência usam pontos de acesso diferentes.

Referência de API · Amostras de código · Trabalhar com campanhas acionadas por API

Limite e controle de pontos de acesso externos capping-throttling

Quando as jornadas chamam sistemas externos por meio de ações ou fontes de dados personalizadas, as APIs de limite e controle protegem esses sistemas contra sobrecarga. O limite rejeita chamadas que excedem o limite configurado; o controle as enfileira por até 6 horas (sandboxes de produção, somente ações personalizadas).

Referência da API de limite · Trabalhar com a API de limite · Trabalhar com a API de controle

Mais REST APIs more-rest-apis

Além de mensagens e limites de frequência, o Journey Optimizer disponibiliza pontos de acesso REST para gerenciamento de supressão, criação de modelos de conteúdo, recuperação de campanhas, provas e execução orquestrada de campanhas. Use-os quando precisar automatizar operações que, de outra forma, exigiriam etapas manuais na interface, por exemplo, suprimir endereços em massa após um pull de dados ou sincronizar modelos de um pipeline de conteúdo externo.

O que você precisa fazer
Referência da API
Excluir programaticamente endereços de email ou domínios do envio
API de supressão · Gerenciar a lista de supressão
Recuperar metadados de jornada para auditoria ou sincronização externa
API de jornadas
Criar e gerenciar modelos e fragmentos de conteúdo de um pipeline externo
API de conteúdo · Modelos · Fragmentos
Recuperar e filtrar Campanhas de ação
API de campanhas
Visualizar campanhas e enviar provas de forma programática
API de simulações
NOTE
A API de simulações está disponível para campanhas acionadas por API e de Ação (agendadas). Não é compatível com campanhas orquestradas: em vez disso, use o fluxo de trabalho de visualização e de prova na interface da campanha orquestrada nesses casos.

| Validar conjuntos de dados e acionar a execução de campanha orquestrada | Validação de conjunto de dados · Acionar · Habilitar conjuntos de dados |

Recursos adicionais additional-resources

Colaborar entre funções next-steps

O trabalho de implementação cruza com o trabalho de outros membros da equipe:

Trabalhar com Engenheiros de dados

Colabore com Engenheiros de dados em configurações de dados e eventos. Toda jornada que reage ao comportamento do usuário depende dos eventos enviados — o Engenheiro de dados define os esquemas e você implementa o código que os produz.

  • Obtenha os esquemas XDM e as estruturas de evento necessárias para implementar
  • Entenda quais eventos é preciso enviar e o formato de conteúdo exigido — consulte trabalhar com eventos de jornada
  • Confirme os campos obrigatórios e opcionais em cada conteúdo do evento e o que acontece nas jornadas quando os campos esperados estão ausentes ou malformados — consulte requisitos de esquema
  • Teste a entrega de eventos e a ingestão de dados em conjunto usando o Adobe Experience Platform Assurance
Trabalhar com administradores

Colabore com os Administradores no acesso e nas configurações de canal. As jornadas só podem alcançar os usuários por meio de canais configurados pelo administrador — coordene antecipadamente para que o SDK funcione e a configuração permaneça sincronizada.

Trabalhar com profissionais de marketing

Colabore com os Profissionais de marketing no design e nos testes de jornadas. Os profissionais de marketing criam as jornadas e o conteúdo que dependem totalmente dos eventos enviados e das superfícies expostas — quanto mais próximo for o alinhamento, mais rapidamente as jornadas serão ativadas.

Comece a implementar

Pronto(a) para começar a criar? Escolha a primeira área de implementação nas seções acima:

  1. Aplicativo móvel? Inicie com a integração do SDK móvel
  2. Site? Comece com a configuração do SDK da Web
  3. Integração da API? Ir para a seção Trabalho com APIs
  4. Sistema personalizado? Confira as Ações personalizadas

Cada seção inclui links para a documentação técnica detalhada, amostras de código e tutoriais para orientar a implementação.

Outros guias de função other-role-guides

Voltar à Visão geral de funções e responsabilidades · Voltar à Introdução

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