RESTful API¶

The eSales 3 Enterprise Web API v2 Service is a RESTful web service that handles the communication with the Apptus eSales Cluster. Load balancing and failover are both handled automatically.

Connection requirements

If any connection problems are encountered using the Apptus eSales Web API v2, verify that the client that is used is following the Connection requirements.

Getting started¶

API key and credentials¶

To be able to access and use the eSales API, the customer onboarding Prerequirements must be fulfilled.

Resources¶

Base URL¶

The standard base URL for the Apptus eSales Web API v2 is https://{cluster-id}.api.esales.apptus.cloud.

Compression¶

All responses that are applicable from eSales will be compressed with gzip if the header Accept-Encoding has the value gzip. Imports and dynamic page requests can have their request bodies compressed with gzip if the header Content-Encoding has the value gzip. It is recommended that the imports are compressed.

Request parameters¶

All API end points have different required parameters. All required parameters are to be considered as case sensitive. It is recommended to set a user-agent request header in all client requests to the RESTful API.

End points¶

API playground¶

Try out the API at the Apptus API Playground with your eSales Playground and API credentials.

Last update: September 5, 2022