Skip to main content

Integration API

Use the Integration API to send external information to the Talon.One Rule Engine or to retrieve data in high-load environments. It's the main API for all integration use-cases.

Typical high-load use cases are:

  • Sharing order data with Talon.One. For example the details of an order, a delivery address, or payment information.
  • Checking what campaign effects apply.
  • Updating and retrieving customer data.
important
Unless otherwise stated, all our SLAs in contract are specified for the Integration API only. The Management API is primarily designed to be used by the Campaign Manager.

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

  1. Your system sends a request via the Integration API.
  2. The request is transformed in an event and is 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 effects of the matching rules to the integration layer.
  5. Your system applies the effects as needed.

Represented visually, the relation between your system, the Campaign Manager, 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 API Docs
note

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

Integration API Postman collection​

Find our collections on our Postman workspace.

Run the Integration API in Postman

You can also download the Postman collection and import it into your Postman app:

  1. Right-click this link and select Save Link As... to download the file.
  2. In Postman, in the sidebar, click Import.
  3. Select the downloaded file, or drag the file into the import window.

A new collection named Integration API appears in your Postman app.

Next steps​

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