Configuration information shared by the user interface and the Interact API

While these two components of configuration take place in two different areas, they are related. The Interact API must reference several of the configuration elements within the design environment. You and the person who works with the Interact API must work together to agree on naming conventions, element purpose, and so on. The design is an iterative and collaborative process. As the person works with the Interact API and the touchpoint, you might have to create more events and interaction points. As you design the interaction in the design environment, you might have more requirements for the person who works with the API.

Element shared by name

Several elements of the Interact configuration are referenced by the Interact API. However, only the following three elements are referred to by name:

• Interactive channels
• Interaction points
• events

When you work with the Interact API, you must reference these elements by name. These names must match and they are case insensitive. The names myinteract, myInteract, and mYiNtErAcT all match.

Interact API and runtime information requests

During runtime, the Interact API does request information from interactive flowcharts and treatment rules, however the API calls for that information indirectly. For example, the API never calls an interactive flowchart. However, the API does call an event that requests a resegmentation, which runs all of the interactive flowcharts that are associated with the interactive channel. Likewise, when the API requests offers with the getOffers method, that starts a sequence of events that includes referencing the treatment rules.

Shared Campaign elements

Several Campaign elements can be used in your Interact configuration. You can use these elements in the Interact API to enhance your interaction, including smart segments, campaign start and end dates, offers, and interactive flowcharts.

Use the Interact API to reference these Campaign elements:

• Audience ID
• Audience level
• Custom offer attributes
• Offer code
• Offer description
• Offer effective date
• Offer expiration date
• Offer name
• Offer treatment code

Since these elements are shared across the whole of the design environment, you must decide standards for these elements across your organization. Some of this information you must provide to properly call the Interact API, such as audience ID, and some you request with the API, such as offer attributes.

You can also reference the score for an offer with the Interact API. In general, this score is the marketing score that is assigned to an interaction strategy. This score is relevant for Interact only, not your entire Campaign environment. You can modify or override the marketing score. For more information about the Interact API, see the Interact Administrator's Guide.

Interact API interactions in the runtime environment

When a runtime session starts, that is, when the visitor initiates a contact, the Interact API triggers a startSession. This call can include:

1. Creating a runtime session.

   A runtime session is an instance on the runtime server, which contains all data that is associated with the visitor. This instance includes all known profile data and the results of any requests to the runtime server, such as segment membership or a list of offers.

2. Loading the visitor profile data into the runtime session.
3. Running all interactive flowcharts that are associated with the interactive channel and places the visitor into segments.

As the visitor interacts with the touchpoint, the Interact API can complete several actions that include triggering events, requesting profile information, and changing the audience level of the visitor. When the visitor reaches an interaction point in the touchpoint, the Interact API can request one or more offers or trigger an event. When the visitor leaves the touchpoint by logging out, hanging up, or timing out, the runtime server ends the runtime session.