EDRfinder API Version 3
Base URL
Access to the EDRfinder API can only be made through HTTPS. We do not support HTTP. The base URL of the EDRfinder production API (v2) is
https://api.edrfinder.com/v3
for all requests. Using this endpoint always requires an authentication as described below. Currently we do not provide a public demo endpoint. Endpoints for development and testing purposes are made available to customers only.
Authorization
All production requests to the EDRfinder API require you to provide an authorization token. You must include an Authorization header in all your requests that contains your secret authorization token which is provided to you by our support team.
Authorization=UXCr5BEkCrAFANSyEKoyx5ShHhW9Oaz4
Retrieving Resources with the HTTP GET Method
You can retrieve data from the EDRfinder API by GETting an URL. The easiest way to do this is to copy and paste a URL into your web browser’s address bar or you can also send a GET request from any HTTPS capable application.
Possible GET Response Status Codes
Whenever you send a GET request the EDRfinder API will send back a response to you. The following responses are possible.
200 OK The request was successful and the response body contains the data you requested
401 UNAUTHORIZED The supplied credentials, if any, are not sufficient to access the API
404 NOT FOUND The request was received but the requested data was not found
500 SERVER ERROR We couldn’t return the data due to an internal server error
503 SERVICE UNAVAILABLE We are temporarily unable to return the representation. Please wait for a bit and try again
Using GET requests to access data
GET vehicle information by selecting make, model, my
You can request information about a vehicle by sending a GET request for a vehicle and specify Make, Model and MY.
/vehicles/{make}/{model}/{my}
You always have to set the following parameters:
format The output format you would like to get. Can be json,xml or pdf. If you choose pdf the response will be a vehicle information sheet in form of a pdf document.
verbose Specifies the level of detail you would like to get. Can be true or false. Please note that a value of false is not available in the demo API.
An example request for data about an 2019 Audi A3 in JSON format could look like this.
https://api.edrfinder.com/v3/vehicles/audi/a3/2019?format=json&verbose=false
Another example request for data about an 2019 Audi A3 in PDF format could look like this.
https://api.edrfinder.com/v3/vehicles/audi/a3/2019?format=pdf&verbose=false
GET vehicle information by VIN query
If you do not know make, model and model year for a vehicle of interest but have the VIN you can request information about the vehicle by sending a GET request for a vehicle and provide it’s VIN.
/vinquery/{vin}
The Version 3 API will always return data in JSON format. No other formats are currently available. You always have to set the following parameter:
verbose Specifies the level of detail you would like to get. Can be true or false.
An example request for data about an 2018 Ford Kuga could look like this.
https://api.edrfinder.com/v3/vinquery/WF0AXXWPMAJB54396?verbose=false
Echo authorization header
While using the EDRfinder demo API you do not have to provide an authorization header in your requests. Access to the production API however requires authorization as described above. In order to test your authorization we provide a function that will echo the authorization header that was received by the EDRfinder API. This enables you to test the authorization communication between your system and the EDRfinder API. You can try sending an authorization header by using the standard curl utility.
curl –header „Authorization: My_Secret_Token“ https://api.edrfinder.com/demo-v2/authcheck
This tells you that the authorization header was received and the value you provided is echoed back to you.
Implementation and pricing
The EDRfinder API is easy to implement and we are happy to help you with any questions that might arise. Pricing depends on volume and use case and is individually contracted. Please contact us at edrfinder@edrfinder.com if you are interested in using the EDRfinder API.