Client API

The Client API lets you build your own recommendations and offers experience on top of SparkLoop. Instead of rendering the managed signup-flow widget, the SparkLoop script exposes a small JavaScript SDK — SL.client — that your code calls to generate recommendations and offers, display them in your own UI, and report your readers' choices back to SparkLoop.

You keep full control of the markup, styling and flow. SparkLoop keeps handling everything behind the scenes: targeting, tracking, attribution and payouts.

The Client API is in early beta and only enabled on request. Read Early Access to see what to expect and apply.

In this section

• Early Access — who the Client API is for, what to expect from the beta and how to apply.

• Getting Started — load the script, turn on client mode and make your first call.

• Objects — the Recommendation and Offer objects the SDK returns.

• Recommendations — generate, fetch and subscribe.

• Offers — generate, fetch and claim.

• Testing Your Integration — run every call in test mode while you build.

• Errors & Warnings — error handling and the rules you must follow.