Workflow
The purpose of the Emission Insight API is to calculate the emissions from an activity of a vehicle or machine. An activity of a vehicle can consist of driving only, working only or both.
In addition, this can be a preliminary or a complete calculation. A preliminary calculation is one that has missing data. For example It may be a prediction/pre-calculation of activities or missing data of the machine or its engine(s).
When information is missing, it may be desirable to perform a recalculation at a later time. When the missing information is added, a new calculation can be performed with the now added information and the calculation status will be set to complete.
An example of a complete calculation is an activity for which the actual activity data and all technical information of the vehicle are known.
Required data
The requested information needed for the emission insight calculation model to perform a calculation is based on information that each company or planning system has available.
However, if the data of vehicles or machines are incomplete, we can still make calculations. This requires us to make assumptions, which affects the accuracy of the calculation. This is why Emission Insight has developed its Emission Insight Accuracy Algorithm (EIAA).
An accuracy score is determined based on the assumptions, this is fed back with the calculation for each individual emission. The score determines that there is a possible deviation from the actual emission, the lower the score, the larger the deviation can be. Based on score, you can decide what to do with the output data. If necessary, you can do a recalculation at a later time when you do have all the data available.
Authentication
You need a subscription key to access the API. After creating an account in Emission Insight’s developer portal, you can find your keys in your product subscription details. It is important to keep your key confidential. You should not place the key in publicly distributed code.
API Versions
The current version of the Emission Insight API is v1, meaning that all request paths start with /v1/.
Error Handling
Errors are indicated by standard HTTP status codes. It is important to make sure that your application handles errors in an appropriate way. To that end, please consult the list of expected status code results that is provided with each endpoint’s documentation.
Special care should be taken to ensure proper handling of:
- HTTP 429: too many requests. Your application should be configured to resend the request after some delay, rather than constantly resending the request.If you are encountering 429 errors and would like to increase your translation speed, please contact [email protected].
- HTTP 456: quota exceeded.
- HTTP 422: Unprocessable Entity. Your input is missing required information or one of the fields is not among the given options.
Additional information may be provided by a JSON response that contains more details about the error. In this case, this additional information will be contained in the “message” key.