API¶
The Voyado Elevate API enables server and client side integrations through HTTP requests that returns raw JSON data, enabling unlimited flexibility and customization. The API handles the communication with the Voyado Elevate Cluster and includes both automatic load balancing and fail over.
The API has three main integration areas: Imports to import products and content into Elevate, queries to retrieve results, and notifications to share visitor behavior with Elevate for reporting and behavior analysis.
A JavaScript library, including TypeScript models, is available to facilitate client side integrations to Voyado Elevate using the HTTP API.
Getting started¶
To get started with the Voyado Elevate API integration, a few prerequirements must be met.
- Origin host and cross-origin resource sharing available
- Cluster credentails received
- Connection requirements met
Once these have been met, read through Tips and best practices and continue with integrating queries and notifications using the Storefront API. Meanwhile, products and content is imported using the Admin API.
Origin host and cross-origin resource sharing¶
Cross-origin resource sharing (CORS) is a mechanism for controlling what domain Ajax requests to the cluster are allowed to originate from. Voyado can help with the origin host configuration as part of the customer onboarding process, if you provide the necessary information.
Default configuration allows Ajax requests originating from all origins but a restricted access to the 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)
Connection requirements¶
- TLS version 1.3 is recommended. Version 1.2 is supported.
- Server Name Indication (SNI) enabled.
- A CA certificate store that trusts Let's Encrypt root certificates. For more information, see Let's Encrypt Certificate Compatibility.
- HTTP/2 is recommended. Version 1.1 is also supported.
Tips and best practices¶
Caching¶
A general rule of thumb is to never cache Elevate generated responses. Caching prevents personalization and can cause notifications to be erroneous due to cached tickets. This does not include static data and resources such as images, which can be cached.
Request parameters¶
Query parameters are case-sensitive.
Request headers¶
The APIs support various request headers.
| Name | Values | Description |
|---|---|---|
Accept-Encoding | gzip | Enables compressed gzip responses. For optimal performance, it is advised to consistently use compressed responses. |
Accept | application/json;charset=utf-8,application/jsonlines;charset=utf-8 | Format that the client can process in the request |
Content-Type | application/json;charset=utf-8,text/plain; charset=utf-8 | Format of the data being sent, json is recommended. To support large requests with unique page configurations, queries can be performed through HTTP POST. Queries return JSON objects as responses, but requests in browsers with application/json as Content-Type automatically triggers a preflight request. To avoid this, text/plain is supported as Content-Type and can be used in client side integrations. |
User-Agent | PostmanRuntime/1.2.3 | For internal tracking and troubleshooting, as well as to support potential future features, it is recommended to include a User-Agent header in HTTP API requests. |
Utility resources¶
OpenAPI specification¶
Each version of each API contains a downloadable OpenAPI specification that can be tested using Swagger UI. The specifications are found on the overview page for the corresponding API version.
Postman collections¶
Each version of each API contains a downloadable postman collection that can be tested using the tool Postman. The collections are found on the overview page for the corresponding API version.
Setting environment variables¶
Note that the file uses environment variables, located under the Variables tab in the Postman interface (see image below). To run the requests, the cluster-id variable must first be changed. The cluster-id will automatically be applied to the baseUrl parameter.
