24th Feb 2021

Integration Checklist

Every integration is unique but keep in mind the following points.

Planning stage

  • Which SDK do you want to use (or self-made solution)

    We are currently offering SDKs for: Java, JavaScript, PHP, Ruby and Python. An overview containing the necessary links can be found here: SDK Overview. Since Talon.One is an API based product you are free to create your own solution to connect to the API endpoints.

  • Integration API vs Management API

    Talon.One offers 2 APIs: the Integration API and the Management API. They differ in their authentication methods and their purposes. For most use cases the Integration API is the only API you will need.

    See:

  • What kind of promotions do you want to run?

    Some promotion types like: free item campaigns, referral programs, coupon campaigns or loyalty programs require additional effect handling or some additional attributes. In such situation, ensure from the beginning which promotions you want to run through Talon.One.

    For more information, see Campaign Library.

  • Whitelist IP addresses

    Talon.One offers the possibility to whitelist your IP addresses. This means that only the addresses you send us will be able to send requests to the API endpoints or log in to our UI.

    To whitelist IPs, send the list to support@talon.one.

  • Talon.One proxy

    Since Talon.One is an API-based product, the whole communication to our system is made by sending requests and receiving their responses.

    To simplify and speed up this interaction, we recommend using a proxy to create a persistent connection to your deployment.

    While you are free to create your own solution, you can use the Talon.One proxy and create a persistent connection to our services.

  • Creating your attributes

    Attributes are an important part of the Talon.One integration.

    Attributes allow you to build any kind of promotion based on product properties. For example, they can represent the weight of an item, the segment of a user, a payment method, etc.

    Create them in the Campaign Manager and use them within your session or profile-update requests.

    For more information, see:

Implementation stage

  • Which type of effects do you want to implement?

    The main part of the integration is the implementation of the returned effects.

    Talon.One provides a wide palette of effects. Ensure to cover the ones your marketing team will use in production.

    For more information on available effects, see Integration API effects.

  • Session status handling

    In general, the integration with Talon.One consists in sending customer session updates.

    Since a session is typically defined by its status: open, closed, or canceled.

    When you want to create a new session, pass status: open in the request.

    During the customer's journey, the open status wont' change until the customer reaches the final step, like the checkout step. At this point, pass status: closed.

    Closing a session also feeds the session data into the campaign analytics and a coupon in the session will be redeemed.

    Important: A closed session can't be opened again.

    You can set the status to canceled of open or closed sessions. This resets the analytics data and any coupon redemption related to the session.

  • Sessions and profiles

    A session can be connected to a profile by passing the integration id of the customer as the value of the profileId attribute.

    We highly recommend to always pass a profileId even if the customer is anonymous or not logged in. Once an anonymous customer becomes known, replace the profileId in the session with the new one.

  • Parsing the Meta-Response

    Part of the customer session update response is the meta object. This object contains additional information regarding custom attribute values for all triggered campaigns and most important the reason why a coupon code was rejected.

  • Dealing with error responses

    When a bad request is received, Talon.One returns an error code. Ensure that your system is able to catch them or even monitor them.

    Typical examples of bad requests are when the integration sends an unknown session attribute or a wrongly formatted coupon attribute.

  • Talon.One API URL

    We offer the possibility to move your cluster to a preferred Google cloud location. Moving a cluster will change the API URL, such as test.talon.one/v1/ or test.europe-west1.talon.one/v1/.

    We suggest that you ensure your integration supports URL changes.

Still need help? Get in touch!
Last updated on 24th Feb 2021

Was this article helpful?

Thank you! You have already voted

If you’d like a member of our support team to respond to you, please send a note to support@talon.one