Error Handling
In this guide, we will talk about what happens when something goes wrong while you work with the API.
In this guide, we will talk about what happens when something goes wrong while you work with the API. Mistakes happen, let's look at some status codes and error types you might encounter. We will also talk about how to handle CORS errors.
You can tell if your request was successful by checking the status code when receiving an API response. If a response comes back unsuccessful, you can use the error type and error message to figure out what has gone wrong and do some rudimentary debugging (before contacting support).
Before reaching out to support with an error, please carefully check your code before contacting CarsXE support.
Status codes
Here is a list of the different categories of status codes returned by CarsXE's API. Use these to understand if a request was successful.
- Name
2xx- Type
- Description
- A 2xx status code indicates a successful response.
- Name
4xx- Type
- Description
A 4xx status code indicates a client error — for example we could return a 404 if a VIN is not found etc.
- Name
5xx- Type
- Description
A 5xx status code indicates a server error — you shouldn't be seeing these often but note that v1 returns these for unsuccessful API calls.
CORS Error
Please note that CarsXE API is meant to be called on the server. This is intended to protect your API key from being stolen. If you try making an API call from the browser most modern browsers will block this request.