Nesta página: saiba como os administradores configuram, testam e ativam integrações externas que conectam o Adobe Journey Optimizer a APIs de terceiros para conteúdo dinâmico e personalizado em canais de saída.
Visão geral
O recurso Integrações vincula o Adobe Journey Optimizer a sistemas de terceiros cujos dados e conteúdo combinável você já gerencia em outro lugar. Você pode exibir esse material durante a criação e no momento do envio, o que suporta experiências mais responsivas e personalizadas nos canais que você usa no Journey Optimizer.
Você pode usar esse recurso para acessar dados externos e extrair conteúdo de ferramentas de terceiros, como:
- Pontos de Recompensa dos sistemas de fidelidade.
- Informações sobre preços dos produtos.
- Recomendações de produto dos mecanismos de recomendação.
- Atualizações de logística como status de entrega.
Para começar a usar Integrações, os usuários precisam receber as permissões Gerenciar configuração de integração do AJO e Exibir configuração de integração do AJO. Saiba mais sobre permissões
-
No produto Permissões, abra a guia Funções e selecione a função desejada.
-
Clique em Editar para modificar as permissões.
-
Adicione o recurso Configuração de integração do AJO e selecione as permissões de Integrações apropriadas no menu suspenso.
-
Clique em Salvar para aplicar as alterações.
As permissões de todos os usuários já atribuídos a essa função serão atualizadas automaticamente.
-
Para atribuir essa função a novos usuários, navegue até a guia Usuários no painel Funções e clique em Adicionar usuário.
-
Insira o nome do usuário, seu endereço de email ou escolha na lista e clique em Salvar.
Se o usuário não foi criado anteriormente, consulte esta documentação.
Configurar a integração configure
Como administrador, você pode configurar integrações externas seguindo estas etapas:
-
Navegue até a seção Configurações no menu esquerdo e clique em Gerenciar no cartão Integrações.
Em seguida, clique em Criar integração para iniciar uma nova configuração.
-
Opcionalmente, cole um comando cURL para preencher automaticamente a URL, o método HTTP, os cabeçalhos e os parâmetros de consulta.
-
Forneça um Nome e uma Descrição para a integração.
note NOTE O campo Nome não pode conter espaços. -
Insira o ponto de extremidade de API URL.
Para variáveis de caminho, envolva um rótulo com chaves duplas na URL, por exemplo,
https://api.example.com/v1/products/{{productId}}, e defina cada espaço reservado em Modelo de caminho. -
Configure o Modelo de Caminho com o Nome e o Valor padrão para cada espaço reservado adicionado à URL.
Observe que Name é um rótulo voltado para o profissional de marketing apenas no editor, ele não é enviado na solicitação de API.
-
Selecione o Método HTTP entre GET e POST.
-
Clique em Adicionar cabeçalho e/ou Adicionar parâmetros de consulta conforme necessário para sua integração. Para cada parâmetro, forneça os seguintes detalhes:
-
Parâmetro: o cabeçalho real ou o nome do parâmetro de consulta conforme esperado pela API.
-
Nome: um rótulo compatível com o profissional de marketing para esse parâmetro, os autores o selecionam ao mapear valores em campanhas.
-
Tipo: escolha Constante para um valor fixo ou Variável para entrada dinâmica.
-
Valor: insira o valor diretamente para constantes ou selecione um mapeamento de variável.
-
Obrigatório: especifique se este parâmetro é obrigatório. Para parâmetros obrigatórios Variable, se nenhum valor for resolvido em tempo de execução e nenhum padrão for fornecido, a geração de solicitações falhará com um erro e a chamada de API de saída não será feita.
-
-
Escolha um Tipo de Autenticação:
-
Sem Autenticação: para APIs abertas que não exigem credenciais.
-
Chave de API: autentique solicitações usando uma chave de API estática. Insira seu Nome da Chave de API , Valor da Chave de API e especifique seu Local.
-
Autenticação Básica: usar a Autenticação Básica HTTP padrão. Insira Nome de usuário e Senha.
-
OAuth 2.0: faça a autenticação usando o protocolo OAuth 2.0. Clique no ícone
-
-
Defina a Configuração de política, como o período de Tempo limite, para solicitações de API e opte por habilitar a limitação, o cache e/ou tentar novamente.
note NOTE Com a limitação ativada, as taxas compatíveis são de 50 a 5000 TPS. Os limites se aplicam à integração, não a cada ponto de extremidade de API. Com a repetição habilitada, outras falhas são repetidas três vezes por padrão, com 200 ms, 400 ms e 800 ms entre tentativas. -
Com o campo Carga de resposta, é possível decidir quais campos da saída de exemplo precisam ser usados para a personalização da mensagem.
Clique no ícone
-
Escolha os campos a serem expostos para personalização e especifique os tipos de dados correspondentes.
note NOTE A configuração Carga de resposta define a resposta esperada para criação, incluindo qualquer esquema aplicado nessa etapa. Os profissionais de marketing podem fazer referência somente a campos expostos, os tokens para outros caminhos falham na validação no editor. -
Use Enviar conexão de teste para validar a integração. Saiba mais sobre como testar sua conexão
Depois de validado, clique em Ativar.
-
Acesse a integração recém-criada para:
- Atualização: alterar somente detalhes de Autenticação e configuração de política. As atualizações se aplicam a jornadas e campanhas ativas. Antes de salvar as alterações, use o menu Explorar referências para confirmar onde a integração é usada.
- Arquivar: arquivar uma configuração de Integração.
Após a ativação, clique no ícone do
Comportamento e limites de tempo de envio configure-send-time
No momento do envio, as respostas da API externa podem ter até 4 MB por padrão. Qualquer coisa maior é tratada como um erro de integração e não haverá tentativa quando a falha for causada pelo tamanho da resposta.
As chamadas respeitam a taxa de limitação que você configurou: o Journey Optimizer agenda tentativas até esse limite mesmo quando o sistema externo está inativo ou retornando erros. Se o cache estiver habilitado, somente respostas bem-sucedidas serão armazenadas e reutilizadas até que o cache TTL definido expire; respostas com falha nunca serão armazenadas em cache.
Cada mensagem em fila também carrega uma janela de validade (TTL). Se o processamento for atrasado e uma mensagem ultrapassar essa janela, o sistema a descartará e emitirá um evento MessageValidityExclusion para que o trabalho obsoleto seja liberado da fila e os recursos permaneçam disponíveis.
Testando sua conexão connection
Enviar conexão de teste valida a URL do ponto de extremidade, a autenticação e a estrutura da solicitação em relação à API de destino antes da ativação, o que reduz o risco de falhas de tempo de execução durante o processamento da mensagem.
-
Quando a URL, o método HTTP, os cabeçalhos e os parâmetros de consulta forem definidos, clique em Enviar conexão de teste para executar um teste de conectividade e confirmar a configuração.
-
Na caixa de diálogo Enviar conexão de teste, insira valores padrão para quaisquer espaços reservados de Variável no caminho de URL, cabeçalhos e parâmetros de consulta.
Esses valores são incluídos na solicitação de teste. O Journey Optimizer chama o endpoint e relata se a conexão teve êxito ou falhou.
-
Se o teste retornar uma resposta bem-sucedida, selecione Usar como carga de resposta para copiar o corpo da resposta no campo Carga de resposta, consulte a etapa 10 em Configurar a integração, onde os tipos de dados podem ser detectados e os campos podem ser selecionados para personalização.
-
Se o teste não for bem-sucedido, expanda o menu suspenso Erro para examinar os detalhes da falha, atualize a configuração de integração conforme necessário e execute Enviar conexão de teste novamente.
Depois que o teste for bem-sucedido, selecione Ativar na configuração de integração. Consulte Configurar a integração.
Consulte também
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 explains how administrators configure, test, activate, and manage external integrations that connect Adobe Journey Optimizer to third-party APIs to pull JSON or HTML content for personalized, dynamic content in outbound channels.
Intents:
- Assign the Manage and View AJO integration configuration permissions
- Create an integration by defining URL, path template, HTTP method, headers, query parameters, authentication, and policy configuration
- Validate an endpoint with Send test connection before activating
- Map a sample JSON response and expose selected fields for personalization
- Understand send-time limits, throttling, cache, retry, and message validity behavior
- Update or archive an existing integration and review where it is used with Explore references
Glossary:
- Integrations: Feature that links Journey Optimizer to third-party systems to surface external data and composable content during authoring and at send time (product-specific)
- Path Template: Configuration of Name and Default value for each
{{placeholder}}added in the URL; the Name is a marketer-facing label in the editor only and is not sent on the API request (product-specific) - Policy configuration: Settings for API requests including Timeout, throttling, cache, and retry (product-specific)
- Response payload: Field that defines the expected response for authoring; marketers may reference only exposed fields, and tokens for other paths fail validation in the editor (product-specific)
- Send test connection: Action that validates the endpoint URL, authentication, and request structure against the target API prior to activation (product-specific)
- Explore references: Menu used to review usage of a configuration, including journeys and campaigns that depend on it (product-specific)
- MessageValidityExclusion: Event emitted when a queued message sits past its validity window (TTL) and is discarded (product-specific)
Guardrails:
- This integration feature is restricted to outbound channels (Email, SMS, and Push) and supports pulling JSON or HTML.
- Users need the Manage AJO integration configuration and View AJO integration configuration permissions.
- The Name field cannot contain spaces.
- With throttling enabled, supported rates are 50 to 5000 TPS; limits apply to the integration, not each API endpoint.
- With retry enabled, other failures retry three times by default, with 200 ms, 400 ms, and 800 ms between attempts.
- For mandatory Variable parameters, if no value is resolved at runtime and no default is provided, request generation fails with an error and the outbound API call is not made.
- At send time, responses may be up to 4 MB by default; anything larger is treated as an integration error, and retries are not attempted when the failure is caused by response size.
- If cache is enabled, only successful responses are stored and reused until the cache TTL expires; failed responses are never cached.
- Update applies only to Authentication details and Policy configuration, and those updates apply to live journeys and campaigns.
Terminology:
- Canonical name: Integrations — Acronym: n/a — variants: external integrations, AJO integration configuration
- Synonyms: “Manage” (from the Integrations card) = entry point to “Create Integration”
- Do not confuse: “Send test connection” (validates the configuration before activation) ≠ “Activate” (makes the integration usable by marketers)
- Do not confuse: “Update” (changes Authentication and Policy configuration only) ≠ “Archive” (archives an integration configuration)
FAQ:
- Q: Which channels and formats does this feature support? — It is restricted to outbound channels (Email, SMS, and Push) and supports pulling JSON or HTML.
- Q: What permissions are required? — The Manage AJO integration configuration and View AJO integration configuration permissions.
- Q: What throttling rates are supported? — With throttling enabled, 50 to 5000 TPS, applied to the integration rather than each API endpoint.
- Q: What happens if a send-time response is too large? — Responses over 4 MB by default are treated as an integration error, and retries are not attempted when the failure is caused by response size.
- Q: What can I change on an active integration? — Only Authentication details and Policy configuration; those updates apply to live journeys and campaigns.
- Q: What is a MessageValidityExclusion event? — It is emitted when a queued message sits past its validity window (TTL) and the system discards it.