This article provides a reference guide for the CXI Public API. It covers the endpoint URL, authentication requirements, and HTTP response codes. The API uses HTTPS for secure communication and requires an API token for authentication. The article also explains the meaning of various HTTP response codes used by the API to indicate the success or failure of requests.
Information
Endpoint URL
Authenticated users can interact with any of our URIs by using the specified HTTP request method. We recommend using SSL encryption by issuing requests through HTTPS.
https://api.guidespark.com/public-api/
Authentication
All requests to CXI Public API require you to authenticate yourself to the service. In order to do this, you must send the correct HTTP header with the correct API token.
- Account Key —’X-GSCC-Api-Key’ Used for requests with all privileges and can be restricted.
Note: Account Key currently is only available upon request. Please contact your Tivian representative.
HTTP response codes
CXI Public API uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the ‘2xx’ range indicate success. Codes in the ‘4xx’ range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a transaction failed, etc.). Codes in the ‘5xx’ range indicate an error with CXI servers (these are rare).
- 200 — Success Everything went smooth.
- 204 — No content Success but there is nothing in the response. This is typically reserved for DELETE operation.
- 400 — Bad Request The request was unacceptable, often due to missing a required parameter.
- 401 — Unauthorized Missing or incorrect API token key in header.
- 404 — Not Found The requested resource doesn’t exist.
- 409 — Conflict There is a conflict to perform the request successfully. In this case, the response body contains JSON with a message containing details on what went wrong.
- 5XX — Internal Server Error This is an issue with CXI’s servers processing your request. We are automatically notified so that we can investigate the issue.
FAQ
What is the endpoint URL for the CXI Public API?
The endpoint URL for the CXI Public API is https://api.guidespark.com/public-api/. It is recommended to use HTTPS for secure communication.
How do I authenticate my requests to the CXI Public API?
Authentication is done by sending the correct HTTP header with the API token. You need to include the ‘X-GSCC-Api-Key’ header with your Account Key. Note that the Account Key is currently only available upon request from your Tivian representative.
What do the different HTTP response codes mean in the CXI Public API?
The CXI Public API uses conventional HTTP response codes: 2xx codes indicate success, 4xx codes indicate client-side errors (e.g., missing parameters, unauthorized access), and 5xx codes indicate server-side errors. Specific codes like 200 (Success), 204 (No Content), 400 (Bad Request), 401 (Unauthorized), 404 (Not Found), and 409 (Conflict) are explained in detail in the article.