Any content that is created or updated in xSuite Helix must have a reservation from the conveyor service. The conveyor service ensures that every request gets a fair chance to be executed in time. It does this by setting limits on the number of requests that each tenant can submit in a specific amount of time.

When the call returns, a reservation key and a header containing a conveyor auth token is returned. See Conveyor Service API (V1).

cURL Example

curl -X POST "https://{customer}.{tenant}.cp.xsuite.com:{port}/api/v1/ConveyorApp/ArchiveBackend/GetReservation" -H "Authorization: Bearer {ACCESS_TOKEN}" -H "accept: application/json" -d ""

Example conveyor reservation key

4c5a405c-f22b-4254-b7dc-8f7350d3ba39

Example conveyor auth token header

x-conveyor-auth-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBsaWNhdGlvbk5hbWUiOiJBcmNoaXZlQmFja2VuZCIsIl9fa2V5IjoiNGM1YTQwNWMtZjIyYi00MjU0LWI3ZGMtOGY3MzUwZDNiYTM5IiwibmJmIjoxNjE5MDE3MTk2LCJleHAiOjE2MTkwMTcyNTYsImlhdCI6MTYxOTAxNzE5NiwiaXNzIjoiaHR0cHM6Ly9pbnRlcm5hbC5Db252ZXlvclRva2VuRmFjdG9yeS5oZWxpeC5jb20iLCJhdWQiOiJodHRwczovL2ludGVybmFsLmV4dGVybmFsLmhlbGl4LmNvbSJ9.EwH6H1vUAsbZOdbGJ0SRNEZujht_jM-DXymc8DVrTdw