Skip to content

Web API v2

The Apptus eSales Web API v2 makes it easy to integrate eSales into a site by enabling client side integration. It consists of two main components:

The Web API also includes methods for GDPR Data Management for Apptus eSales data.

Web API availability

The Apptus eSales Web API v2 is only available for Apptus Cloud customers.

What's new

The eSales Web API v2 has been designed to reduce integration time even more than the previous version and also added new features. The main changes are:

  • Removal of overcomplicated security mechanisms in favour of simpler ones
  • Easier and cleaner query result
  • Stronger validation in notifications and panel queries
  • Exports are now supported

Furthermore v2 comes with a reworked JavaScript library. The major improvements are:

  • Promise-based instead of callback-based implementation
  • More client-side validation of required parameters
  • Better structure and more encapsulation

For more information about breaking changes in Web API v2 and how to upgrade from v1, see upgrading to Web API v2.

Getting started

Supported browsers

The Web API v2 is built to support major browsers such as Mozilla Firefox, Google Chrome, Safari, and Microsoft Internet Explorer (10 and newer).

Pre-requirements

Apptus Cloud environment configuration is a part of the customer on-boarding process. This configuration is performed by Apptus, but for it to be completed some information regarding origin host settings and selected client side payment strategy are needed from the customer.

With this provided to Apptus the initial set-up for the Web API will be performed, and the following information is returned to the customer.

  • A private key / Api-Key - used when importing/exporting data and sending payment notification
  • Cluster id - used when requesting data from the Apptus Cloud
  • Apptus eSales Apps and Manager access rights

When the cloud configuration is completed, customers can contact Apptus Support if there are any questions about the current security settings used for their eSales cluster, or if the security settings must be changed.

Origin host

The origin host is part of the security settings for a cluster. It specifies what domain Ajax requests to the cluster are allowed to originate from.

Default configuration allows Ajax requests originating from all origins but a restricted access to the Web API is recommended. The following information is needed from the customer to configure the origin host correctly:

  • Protocols (HTTP/HTTPS)
  • Domains (subdomains)
  • Ports (80, 443)

Client side payments

Client side payment strategy is part of the security settings for a cluster. There are three different strategies for handling payment notifications with the eSales Web API.

  • Do not allow payment notifications - Default strategy. Should be used when payment notifications are always sent server side.
  • Allow limited payments - Ignore suspicious payments e.g. payment notification that seem to be machine generated.
  • Allow all payment notifications - Most useful at an early stage of the integration.

JavaScript library

The JavaScript library exposes methods to fetch panels and notify events such as clicks, adding to carts, etc. It communicates via Ajax requests with an eSales server in the Apptus Cloud that has the Web API enabled.

For more details of the JavaScript library, see the JavaScript library documentation pages.

RESTful API

The RESTful API handles the communication with the Apptus eSales Cluster. Load balancing and failover are both handled automatically.

For more details of the RESTful API, see the RESTful API documentation pages.

Sessions and notifications

Sessions and notifications are used to keep track of information about visitor interaction that is sent to eSales via the Web API. The information is used to enable personalisation and to improve recommendations and more.

For more details about Notifications, see the Sessions and Notifications page.

Recommendations and best practice

  • Always instantiate an api object as a variable with a url to a cluster and market that exists.
  • Never cache individual items in a result as this may result in personalisation issues. If caching is to be used, an entire query should be cached, not just parts of a result.
  • When notifying payments, the recommended notification method to use is Secure Payment Notification.
×