This article provides an extensive overview of the API architecture of Talon.One and includes the following chapters:
Talon.One provides its services with integrations that connect your shop or service to the Talon.One Integration API. If your business uses one of our supported shops, simply install the plugin and configure it with an API key we provide. More advanced and custom use cases may require the development of an extension so it can talk directly to our API.
Once this configuration is completed, our API will be notified of various customers actions, such as adding or removing items from a shopping cart. Our API detects these events using the Talon.One rule engine, which then checks your campaign rules (see below) and carries out the effects of the matching rules.
Each campaign contains a set of rules, made up of a condition, and the effects that should take place when the condition is met. These rules are defined using a drag and drop interface in our Campaign Manager. This interface facilitates the building of complex conditions with logical
OR operators, e.g. " the customer is Canadian AND has completed an order in the last 90 days".
Multiple effects can be added to each rule such as giving a discount, updating internal scores for a customer, or even making a request to an external web service. The most common use cases are covered in the drag-and-drop rule editor right out of the box, but can be further customized with conditions and effects specific to your needs.
These two flows (creating campaign rules and applying them to customer data) can be visualized like like this:
Further Reading: Data Model
The operations supported by the Talon.One API are divided into two distinct categories: integrations and campaign management.
Every integration will need to send data about customers and their activities to the Talon.One rule engine. This information is required so your campaign rules can trigger discounts, special offers, referral rewards, etc. We refer to this category of API operations as our Integration API.
The second category is our Management API, where you can fully control and report on your campaigns with code (instead of creating campaigns and rules in our Campaign Manager interface). Organizations who wish to utilize the functionality of Talon.One through an existing back-office system can use this API. For example, a marketplace platform using Talon.One to power their own offerings of automated loyalty, referral, or coupon programs.
Each API requires different authentication:
Requests made to the Integration API must be signed with the secret key of your shop. This key can be found in the settings tab of your shop in the Campaign Manager.
Requests made to the Management API must be authenticated with a bearer token corresponding to a registered Talon.One user. You can obtain this token with the
More details about the API operations available and example code for signing requests can be found in our API Documentation.