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 or to retrieve data in high-load environments. It the main API for all integration use-cases.

Typical use cases are:

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

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.

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.

See the Integration API reference docs.

note

In non-high-load contexts, you can use the endpoints available in the Management API.

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.

Next steps

Read about API effects and see the Integrating Talon.One tutorial.