Technical Service Bulletins (TSB) – CarMD API2019-06-10T22:08:15+00:00

Technical Service Bulletins (TSB) – CarMD API

CarMD TSB API works on all vehicles sold in the US since 1996. It provides information on a vehicle’s technical service bulletins. These bulletins are recommended methods of repairing vehicles offered by the OEM.

For a more indepth description, please see Wikipedia.

This API provides data on the following elements:

  • Manufacturer’s TSB ID
  • Summary description of TSB
  • Category of TSB
  • PDF of full TSB

For specific details, please see our API Documentation for TSB.

Testing the API

This document will guide a user to testing the endpoint without having to touch any code other than the endpoint data.

1 – Register an account or login to grab your API keys.

Once you reach your dashboard, click Next as shown below to view your keys.

CarMD API member page

2 – Download and open your RESTful client

Install Advanced REST client for Google Chrome.

Open the client by going to the app. Then click Launch app.

Open your RESTful client

3 – Add TSB API endpoint and data

Once you’re at the main screen of the client insert the endpoint and parameter data into the Request URL field at the top.

Example endpoint and parameter data 1 (copy and paste the line below into the client):

http://api.carmd.com/v3.0/tsb?vin=1GNALDEK9FZ108495

4 – Adding your header

At this point we’re prepping to add your authorization and partner keys to the header, first lets setup the header.

Under Parameters, click Insert headers set.

The default header will display, then click USE THIS SET

The result should look like below:

5 – Adding your keys to the header

Here we’re going to add your keys to the header. First lets open up some fields in your header by clicking ADD HEADER twice.

It should look like this.

Now add your keys to the empty header fields.

6 – Sending your request

Submit your request by clicking SEND. The response may take a few seconds.

Your response should look something like the below.

If so, congrats and thank you for using CarMD’s API!

Response

Each response is broken down into two portions, one is the message which contains basic diagnostic results of the request and the other is the data.

Your TSB information will be contained in the ‘data’ field.

CarMD TSB API works on all vehicles sold in the US since 1996. It provides information on a vehicle’s technical service bulletins. These bulletins are recommended methods of repairing vehicles offered by the OEM.

For a more indepth description, please see Wikipedia.

This API provides data on the following elements:

  • Manufacturer’s TSB ID
  • Summary description of TSB
  • Category of TSB
  • PDF of full TSB

For specific details, please see our API Documentation for TSB.

Testing the API

This document will guide a user to testing the endpoint without having to touch any code other than the endpoint data.

1 – Register an account or login to grab your API keys.

Once you reach your dashboard, click Next as shown below to view your keys.

CarMD API member page

2 – Download and open your RESTful client

Install Advanced REST client for Google Chrome.

Open the client by going to the app. Then click Launch app.

Open your RESTful client

3 – Add TSB API endpoint and data

Once you’re at the main screen of the client insert the endpoint and parameter data into the Request URL field at the top.

Example endpoint and parameter data 1 (copy and paste the line below into the client):

http://api.carmd.com/v3.0/tsb?vin=1GNALDEK9FZ108495

4 – Adding your header

At this point we’re prepping to add your authorization and partner keys to the header, first lets setup the header.

Under Parameters, click Insert headers set.

The default header will display, then click USE THIS SET

The result should look like below:

5 – Adding your keys to the header

Here we’re going to add your keys to the header. First lets open up some fields in your header by clicking ADD HEADER twice.

It should look like this.

Now add your keys to the empty header fields.

6 – Sending your request

Submit your request by clicking SEND. The response may take a few seconds.

Your response should look something like the below.

If so, congrats and thank you for using CarMD’s API!

Response

Each response is broken down into two portions, one is the message which contains basic diagnostic results of the request and the other is the data.

Your TSB information will be contained in the ‘data’ field.