Sobre a API do Interact

A configuração do Interact para trabalhar com o seu ponto de discussão do cliente é composta por dois componentes principais:

Configuração do ambiente de design do Interact.

Configuração do seu ponto de discussão do cliente para trabalhar com o ambiente de tempo de execução usando a API do Interact.

Embora estes dois componentes de configuração ocorram em duas áreas diferentes, eles estão relacionados. A API do Interact consulta vários dos elementos de configuração dentro do ambiente de design. Você e a pessoa que está trabalhando com a API do Interact devem trabalhar juntos e devem estar de acordo sobre as convenções de nomes, propósito dos elementos, e assim por diante. Este é um processo interativo e colaborativo. À medida que uma pessoa trabalha com a API do Interact e com o ponto de discussão do cliente, talvez seja necessário criar mais eventos e pontos de interação. À medida que você desenha a interação no ambiente de design, talvez surjam mais requisitos para a pessoa trabalhando com a API.

Existem vários elementos da configuração do Interact que são mencionados pela API do Interact. Contudo, somente os três elementos a seguir são mencionados pelos nomes:

canais interativos

pontos de interação

eventos

Você deve fazer referência a estes elementos pelo nome quando trabalhar com a API do Interact. Estes nomes devem coincidir, contudo o sistema não faz distinção entre letras maiúsculas e minúsculas para estes nomes. Os nomes myinteract, myInteract e mYiNtErAcT são idênticos para o sistema.

Existem outros elementos de configuração do Interact que você pode usar na API do Interact para melhorar a sua interação, incluindo segmentos inteligentes, datas de início e fim de campanha, ofertas e fluxogramas interativos.

Durante o tempo de execução, a API do Interact solicita informações dos fluxogramas interativos e regras de tratamento, contudo a API solicita as informações indiretamente. Por exemplo, a API nunca faz solicitações ao fluxograma interativo. Contudo, a API solicita um evento requisitando uma resegmentação, que executa todos os fluxogramas interativos associados ao canal interativo. Da mesma forma, quando a API solicita ofertas com o método do getOffers, que inicia uma sequência de eventos que inclui consultar as regras de tratamento.

A API do Interact consulta os seguintes elementos do Campaign:

ID de audiência

nível de audiência

atributos de ofertas personalizadas

código da oferta

descrição da oferta

data de efetivação da oferta

data de expiração da oferta

nome da oferta

código de tratamento da oferta

Uma vez que estes elementos são compartilhados dentro do ambiente de design, é necessário decidir os padrões para estes elementos em toda a organização. Algumas destas informações devem ser fornecidas para chamar corretamente a API do Interact — tais como a ID da audiência — e algumas você solicita com a API — tais como os atributos de oferta.

Você também pode consultar a pontuação para uma oferta com a API do Interact. Geralmente, esta é a pontuação de marketing atribuída na guia Estratégia de interação. Esta pontuação só é relevante para o Interact, não para todo o ambiente do Campaign. Você pode modificar ou anular a pontuação de marketing da guia Estratégia de interação. Para obter mais informações sobre a API do Interact, consulte o Guia do administrador do Interact.

Tempo de execução do Interact

A seção a seguir oferece uma descrição resumida do que acontece no servidor de tempo de execução durante uma interação.

Quando uma sessão de tempo de execução se inicia, isto é, quando o visitante inicia um contato, a API do Interact dispara um startSession. Esta chamada pode incluir as seguintes etapas.

1.	Criar uma nova sessão de tempo de execução.

Uma sessão de tempo de execução é uma instância no servidor de tempo de execução que contém todos os dados associados ao visitante. Isso inclui todos os dados conhecidos do perfil e os resultados de qualquer solicitação ao tempo de execução, tal como membros de segmento ou uma lista de ofertas.

2.	Carregar os dados do perfil do visitante em uma sessão de tempo de execução.

3.	Executar todos os fluxogramas interativos associados ao canal interativo e colocar o visitante em segmentos.

À medida que o visitante interage com o ponto de discussão do cliente, a API do Interact pode executar várias ações incluindo disparar eventos, requerer informações sobre o perfil e mudar o nível de audiência do visitante. Quando o visitante alcança um ponto de interação no ponto de discussão do cliente, a API do Interact pode solicitar uma ou mais ofertas ou disparar um evento. Quando o visitante sai do ponto de discussão do cliente — fazendo logoff, desligando ou caso a sessão expire, o servidor de tempo de execução encerra a sessão de tempo de execução.

Esta é uma descrição básica. Existem vários recursos opcionais que podem ser ativados para que você possa influenciar a recomendação da oferta, por exemplo, o módulo de aprendizado. Para obter mais informações sobre estes recursos opcionais, consulte o Guia do administrador do Interact.