RESTful API¶

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

Getting started¶

API key and credentials¶

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

Resources¶

Base URL¶

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

Compression¶

All responses that are applicable from Elevate 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¶

• Panel query
• Dynamic page
• Click notification
• Non-eSales click notification
• Adding to cart notification
• Non-eSales adding to cart notification
• Add favorite notification
• Remove favorite notification
• Payment notification
• Secure payment notification
• End notification
• Imports
• Import Status
• Exports
• Product selection exports
• Customer keys migration
• Status

API playground¶

The API can be easily be tested using either of the downloadable resources below:

• API 2 open API specification with Swagger UI
• API 2 postman collection with Postman
  Note postman environment variables are located in the Variables tab. Update the clusterId variable before running requests. The baseUrl parameter will be updated with the new clusterId automatically.