Skip to main content

Overview

We recommend you read the Getting started overview, first.

When to use the Integration API#

Use the Integration API to feed external information to the Talon.One Rule Engine.

Typical examples are:

  • sharing order/cart data, such as cart items, delivery address or payment information.
  • sharing customer data, such as total sales or loyalty memberships.

Here is a usual example of workflow with the Integration API:

  1. Your application sends a request via the Integration API.
  2. The request is transformed in event and sent to the Rule Engine.
  3. The Rule Engine uses this event to find the rules that match the current event.
  4. The Rule Engine returns the effect(s) of the matching rules to the integration layer.
  5. The integration layer applies the effect(s) as needed.
note

If you want to query and interact with the data managed inside Talon.One, see the Management API.

Represented visually, the relation between the Campaign Manager, your application, and the Rule Engine is as follows:

Flow Diagram

The only coupling of your integration with campaigns is through the Rule Engine: the integration must send the attributes that the rule engine requires.

Postman collection#

You can use the following postman collection:

  1. Download and import these 2 files in Postman.

  2. Select the imported Talon.One env environment and set the API Key and URL variables.

  3. Run other queries by setting potential required variables like Application_id.

See also: