Skip to main content

Generic CEP integration

You can integrate with any customer engagement platform (CEP) using Talon.One's endpoints for third-party tools.

important

These endpoints are for general use with any platform. If you use a partner listed in the Customer engagement platforms section, do not follow this tutorial. Instead, refer to a tutorial specific to your platform.

The following endpoints are available:

See API Docs

Authenticating​

All CEP endpoints rely on Talon.One's third-party API keys of type Customer Engagement.

To generate an API key:

  1. In your Application, click Settings > Integration API Keys.

  2. Click Create API Key.

  3. In the Create API Key drawer, if you are asked for a key type, select Production.

  4. In Key name, type a name to identify the key.

  5. In Key expiration date, select a date.

  6. In Third-party integration, select Yes.

  7. From Platform, select Customer Engagement Platform.

  8. Click Create API Key.

  9. Click to copy the key for use.

    10. note

    You cannot view or copy the API key after closing the drawer. If you lose it, create another API key.

Use the key in the Authorization header of each of the endpoints. For example:

Authorization: ApiKey-v1 dbc644d33aa74d582bd9479c59e16f970fe13bf3

Creating a coupon​

To create a coupon code from a CEP platform, use the following endpoint:

GET Create coupon
https://integration.talon.one/customer_engagement/coupon

See API Docs

Creating a referral​

To create a referral code from a CEP platform, use the following endpoint:

GET Create referral
https://integration.talon.one/customer_engagement/referral

See API Docs

Fetching a loyalty ledger​

To fetch loyalty ledger information from a CEP platform, use the following endpoint:

GET Get loyalty ledger
https://integration.talon.one/customer_engagement/loyalty

See API Docs

Adding loyalty points​

To add loyalty points from a CEP platform, use the following endpoint:

POST Add loyalty points
https://integration.talon.one/customer_engagement/add_loyalty_points

See API Docs