Skip to content

RESTful API v1

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

Java version recommendation

For security reasons, Java 8 is recommended when sending requests to the Apptus eSales Web API using Java.

Getting started

API key and credentials

To be able to access and use the eSales API, the customer on-boarding Pre-requirements must be fulfilled.


Base URL

The standard base URL for the Apptus eSales Web API is https://{cluster-id}

Request parameters

All API endpoints have different required parameters. All required parameters are to be considered as case sensitive.


API playground

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