Nesta página: configure seu sistema de dados para enviar eventos para as APIs de assimilação de streaming, de modo que os eventos configurados realmente cheguem à Journey Optimizer e acionem suas jornadas.
Para configurar eventos a serem enviados para APIs de assimilação de streaming e para serem usados em Journey Optimizer, é necessário seguir estas etapas:
- Obtenha o URL de entrada das APIs do Adobe Experience Platform. Saiba mais em Visão geral das APIs de assimilação de streaming.
- Copie a carga da visualização de carga no menu Evento. Saiba mais nesta página.
Em seguida, é necessário configurar o sistema de dados que envia eventos para as APIs de assimilação de streaming usando a carga útil copiada:
- Configure uma chamada de API POST para o URL das APIs de assimilação de streaming (chamada de entrada).
- Use a carga copiada de Journey Optimizer no corpo (“seção de dados”) da chamada da API para as APIs de assimilação de fluxo. Veja um exemplo abaixo
- Determine onde obter todas as variáveis presentes na carga. Exemplo: se o evento deve transmitir o endereço, a carga colada mostrará “address”: “string”. “string” deve ser substituída pela variável que preencherá automaticamente o valor correto, o email da pessoa para a qual enviar uma mensagem. Observe que na pré-visualização de carga, na seção Cabeçalho, preenchemos automaticamente muitos valores esperados para facilitar seu trabalho.
- Selecione “application/json” como um tipo de corpo.
- Passe a ID da organização no cabeçalho usando a chave “x-gw-ims-org-id”. No valor, use a ID da organização (“XXX@AdobeOrg”).
Este é um exemplo de um evento de APIs de assimilação de fluxo:
{
"header": {
"msgType": "xdmEntityCreate",
"msgId": "c25585b9-252e-431d-b562-e73da70c04e7",
"msgVersion": "1.0",
"xactionId": "f5995abe-c49d-4848-9577-a7a4fc2996fb",
"datasetId": "string - required if you want the data to land in a specific dataset - not mandatory",
"imsOrgId": "XXX@AdobeOrg",
"schemaRef": {
"id": "XXX",
"contentType": "application/vnd.adobe.xed-full+json;version=1"
},
"source": {
"name": "Journeys"
}
},
"body": {
"xdmMeta": {
"schemaRef": {
"id": "XXX",
"contentType": "application/vnd.adobe.xed-full+json;version=1"
}
},
"xdmEntity": {
"_instance_name": {
"person": {
"firstName": "string",
"lastName": "string",
"gender": "string",
"birthYear": 10,
"emailAddress": "string"
}
},
"identityMap": {
"Email": [
{
"id": "string"
}
]
},
"_id": "string",
"timestamp": "2023-05-29T00:00:00.000Z",
"_experience": {
"campaign": {
"orchestration": {
"eventID": "XXX"
}
}
}
}
}
}
Para facilitar a identificação do local onde colar a parte de “dados”, você pode usar uma ferramenta de visualização JSON, como o formatador JSON.
Para solucionar problemas de APIs de assimilação de fluxo, consulte a documentação do Experience Platform.
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 the additional steps to set up a data system that pushes events to the Streaming Ingestion APIs, using the payload copied from the payload preview, so configured events actually reach Journey Optimizer and trigger journeys.
Intents:
- Get the inlet URL from Adobe Experience Platform APIs
- Copy the payload from the payload preview in the Event menu
- Set up a POST API call to the Streaming Ingestion APIs inlet using the copied payload
- Map the payload variables to the values that should populate them
- Configure the request body type and the organization ID header for the call
Glossary:
- Streaming Ingestion APIs: The Adobe Experience Platform APIs to which events must be pushed so they reach Journey Optimizer (product-specific)
- Inlet: The Streaming Ingestion APIs URL to which the POST API call is sent (product-specific)
- Payload preview: The view in the Event menu from which you copy the payload to use in the body of the API call (product-specific)
- x-gw-ims-org-id: The header key used to pass your organization ID in the API call (product-specific)
Guardrails:
- Set up a POST API call to the Streaming Ingestion APIs URL (the inlet) and place the copied payload in the body, the data section, of the call.
- Select application/json as the body type.
- Pass the organization ID in the header using the key x-gw-ims-org-id, with the organization ID value in the form XXX@AdobeOrg.
- In the payload preview Header section, many expected values are autofilled to facilitate the work.
Terminology:
- Canonical name: Streaming Ingestion APIs — Acronym: n/a — variants: inlet, inlet URL
- Synonyms: “inlet” = “Streaming Ingestion APIs URL”
- Do not confuse: “header” (section carrying values such as x-gw-ims-org-id) ≠ “body” (the data section carrying the payload)
FAQ:
- Q: Where do I get the payload to send? — Copy it from the payload preview in the Event menu.
- Q: What body type should the API call use? — application/json.
- Q: How do I pass the organization ID? — In the header, using the key x-gw-ims-org-id with the value in the form XXX@AdobeOrg.
- Q: What kind of API call is used to send events? — A POST API call to the Streaming Ingestion APIs URL, called an inlet.