Check out our new and improved API ReferenceOpen now

Documentation for Developers

Resources and APIs for integrating with the cleverbridge platform and extending its capabilities

Tip

Log in with your Commerce Assistant credentials and gain access to client-only content marked with an asterisk. This includes the latest version of the Commerce Assistant (CA) and Business Intelligence (BI), forms and lists, as well as the clearing & payouts guide.

API Reference

cleverbridge maintains a rich set of APIs that extend the capabilities of the ecommerce platform and enable various types of integration between the cleverbridge platform and your system. All cleverbridge APIs adhere to the principles of REST. This makes them simple to use, regardless of your platform or programming language.

Integrating Your System

Getting Started with Integration

Are you a developer who wants to get started with the ecommerce platform? cleverbridge recommends that you complete several steps.

Overview of APIs

cleverbridge's APIs were engineered to serve a variety of purposes.

Cart API

The Cart API allows you to handle cart operations, such as automatically processing a customer's shopping cart.

Product API

The Product API allows you to retrieve information about your products.

Product & Pricing API

The Product & Pricing API allows your customers' web browsers to communicate with the cleverbridge platform and automatically populate your web pages with up-to-date product, price, promotion, and geo IP data.

Purchase API

The Purchase API allows you to retrieve information about the purchases of your products.

Subscription API

The Subscription API allows you to acquire information about your subscriptions. It also gives you the option of processing a number of different API calls in order to change or update existing subscriptions.

URL Generator API

The URL generator API allows you to generate two URL types.

License Key Generators

License key generation dynamically creates a key when requested at the time of the order. You set up a web-based key generator and then specify how the ecommerce platform connects to the server.

License Key Upgrades

As a client, you can provide software license key upgrades at discounted prices. You can choose to authenticate customers’ credentials for these offers.

Single Sign-On (SSO)

Single sign-on can be used to pass customer information from your system into the cleverbridge checkout process. cleverbridge then maps this data to the corresponding checkout data fields and optimizes the customer experience.

Notifications

Notifications are used to upload data exports of transactional data on a regular basis for use in your internal systems. You can choose to receive notifications for particular events and you can configure notification delivery to as many contacts as necessary.

Salesforce

The cleverbridge platform is designed to work with customer relationship management (CRM) provider Salesforce.com. The cleverbridge platform can be linked to Salesforce using an API so that incoming purchases and partner registrations are automatically pushed to the Salesforce database.

Using the Platform

Checkout Process Guide

This guide explains how you can optimize your checkout process using the ecommerce platform. It also explains how to take advantage of the wide-variety of links and URL parameters that cleverbridge offers.

Payments & Transactions Guide

This guide goes into detail about the fraud, compliance, taxation, currency, and payment solutions that the ecommerce platform supports. It also explains how to get information about transactions and communicate with your customers.

Products & Pricing Guide

This guide explains how to leverage the ecommerce platform in order to present your products in the best possible light. You can also learn about the different delivery options that cleverbridge supports and how to optimize your pricing.

Reporting & Analytics Guide

This guide provides an overview of the two cleverbridge reporting tools and a comparison of what each offers. It leads you through the basic steps for creating a report in the Business Intelligence application. You can also get an overview of revenue tracking by using x-parameters and learn how to set up and view revenue tracking. Finally, the guide describes how to integrate third-party analytics code with the checkout process with the third-party tracking setup feature in the Commerce Assistant.

Subscriptions & Recurring Billing Guide

This guide lists all 60+ subscription use cases supported by cleverbridge, organized by life cycle stage. It identifies the components of the cleverbridge platform that support every use case, such as the Commerce Assistant, the cleverbridge checkout process, the Subscription or ProcessCart API, database settings, and so on.