Getting Started

Welcome to the Talon.One developer documentation. Here you can find guides, tutorials, SDKs and reference documentation to help you effectively integrate Talon.One.

Talon.One is a comprehensive solution for creating, deploying, and tracking incentivized buying campaigns. Talon.One provides you with a one-stop shop for managing coupon codes, loyalty programs, and referral rewards. At its core is our flexible Rule Engine coupled with our easy-to-use Campaign Manager.

Understanding Talon.One in 2 minutes

Enough marketing-talk? Quickly grasp what Talon.One is in a nutshell.

Try out Talon.One in 5 minutes

Make your first API requests to see how our Integration and Management APIs work together to enable powerful campaign logic & reporting.

Creating a Customer Profile

The central entity of Talon.One is your customer, represented by a Customer Profile. These profiles are modified using the updateCustomerProfile API operation. Click the send button to try it out:

Create profile with ID 158e3117
curl -X PUT https://demo.talon.one/v1/customer_profiles/158e3117 \
    -H 'Content-Signature: signer=73; signature=b240f0bcdb8e629b5a9ed32eed0b4cfd' \
    -d '{
      "attributes": {
        "Name": "Carlton Banks",
        "Email": "carltonb@gmail.com"
      }
    }'

The response contains the profile, as well as a session and event. We'll get to sessions soon, for now we're only interested in verifying that profile.attributes contains the data we just sent:

Please click "Send" to see the response data

If we repeat this operation with the same profile ID, new attributes will be merged:

Update profile 158e3117
curl -X PUT https://demo.talon.one/v1/customer_profiles/158e3117 \
    -H 'Content-Signature: signer=73; signature=a031fcb8d6767971ea8874534fbcd971' \
    -d '{
      "attributes": {
        "Email": "carltonb@hushmail.com"
      }
    }'

Please click "Send" to see the response data

Creating a customer session

Simply storing and updating a profile is not particularly impressive, where Talon.One starts to get more interesting is Customer Sessions. You can think of these as a more generalized version of an orders in an e-commerce system. Any customer can have multiple sessions going at once, and these sessions can accumulate cart items and discounts.

Let's say Carlton has just added an item to an empty basket, we start a new session like so:

Create a customer session for order 2862g671
curl -X PUT https://demo.talon.one/v1/customer_sessions/2862g671 \
    -H 'Content-Signature: signer=73; signature=d3b943f4c9c6dfa6f04be31ba15818e8' \
    -d '{
      "profileId": "158e3117",
      "cartItems": [
        {
          "name": "Cashmere sweater made with premium NZ wool",
          "sku": "k-1536",
          "category": "Mens Sweaters",
          "price": 147.99,
          "quantity": 3,
          "attributes": {
            "Color": "Buttercream",
            "Size": "Large"
          }
        }
      ],
      "total": 443.97
    }'

We can see that the response contains both information about the current session, and details about the profile we created earlier.

Please click "Send" to see the response data