This online publication is intellectual property of Apptus Technologies. Its contents can be duplicated in part or whole, provided that a copyright label is visibly located on each copy and the copy is used in conjunction with the product described within this document.
All information found in these documents has been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. Neither Apptus Technologies nor the authors shall be held liable for possible errors or the consequences thereof.
Software and hardware descriptions cited in these documents might be registered trademarks. All trade names are subject to copyright restrictions and may be registered trademarks. Apptus Technologies essentially adheres to the manufacturer’s spelling. Names of products and trademarks appearing in this document, with or without specific notation, are likewise subject to trademark and trade protection laws and may thus fall under copyright restrictions.
CLOSERESTful API v1¶
The eSales Enterprise 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 onboarding Prerequirements must be fulfilled.
Resources¶
Base URL¶
The standard base URL for the Apptus eSales Web API 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 endpoints 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.
Endpoints¶
- Panel Query
- Dynamic Page
- Click Notification
- Non-eSales Click Notification
- Adding to Cart Notification
- Non-eSales Adding to Cart Notification
- Add Favourite Notification NEW
- Remove Favourite Notification NEW
- Payment Notification
- Secure Payment Notification
- End Notification
- Imports
API playground¶
Try out the API at the Apptus API Playground with your eSales Playground and API credentials.