Base URI
- PRODUCTION - https://api.syndigo.com
- UAT - https://api.uat.syndigo.com
If you wish to be granted access to use the UAT environment, please contact your account representative or Syndigo Support.
Headers
All requests must contain the following headers:
- Content-Type: application/json
Authentication
Retrieve your API username and secret from the Self Service portal accessible via the CXH Login page. Using these API specific credentials you must generate a temporary (180 minute) authorization token from the auth API. For more information, see GET api/auth?username={username}&secret={secret}.
Apply this token as an Authorization header to all API requests.
- Authentication: EN {token}
Space between EN and token.
companyid
Nearly all requests to this API set, except for the auth endpoint, require your companyid to be passed as part of the URI route. You can retrieve this id from the Self Service portal accessible via the CXH Login page.
This id is a UUID\GUID that is the unique identifier for your company within the CXH ecosystem. If your account has been configured with multiple subaccounts, you may have multiple companyids.
Dates and times
All dates and times are in ISO 8601 format, specifically:
- yyyy-mm-ddThh:mm:ss (If a time is specified)
- yyyy-mm-dd (For dates only)
- All times and dates are UTC.