Wheel Fitment API Client SDK for Node.js
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.swagger-codegen
docs
src
test
.gitignore
.swagger-codegen-ignore
.travis.yml
README.md
git_push.sh
mocha.opts
package.json

README.md

ws-api-client-nodejs

The Wheel Fitment API allows for programmatic access to the database of www.wheel-size.com and its services. Use this API to retrieve information about vehicle fitment database for rims and tires, including OE and option fitments, and plus/minus sizing fitment information. A variety of country and language specific options are available. The coverage of fitment data for vehicles manufactured since 2000 is nearly 100%. The information about fitment data is updated on a daily basis.

This SDK is automatically generated by the Swagger Codegen project:

  • API version: v1
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install ws-api-client-nodejs --save
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your ws-api-client-nodejs from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('ws-api-client-nodejs') in javascript files from the directory you ran the last command above from.

git

    npm install driveate/ws-api-client-nodejs --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var ws_api_client = require('ws-api-client-nodejs');

var defaultClient = ws_api_client.ApiClient.instance;

// Configure API key authorization: user_key
var user_key = defaultClient.authentications['user_key'];
user_key.apiKey = "YOUR API KEY"

var api = new ws_api_client.MakesApi()

var opts = { 
  'countries': "us,gb,jp", // {String} Show information for local manufacturers from specified countries only. Use `GET /countries/` method to get the full list of countries. (e.g. `us,gb,jp`)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + JSON.stringify(data, null, 2));
  }
};
api.makesList(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.wheel-size.com/v1

Class Method HTTP request Description
ws_api_client.BoltPatternsApi boltPatternsList GET /bolt-patterns/ Get list of bolt patterns
ws_api_client.BoltPatternsApi boltPatternsRead GET /bolt-patterns/{bolt_pattern}/ Model modifications by bolt pattern
ws_api_client.CountriesApi countriesList GET /countries/ Returns a list of countries
ws_api_client.GenerationsApi generationsList GET /generations/ Generations for the given model
ws_api_client.MakesApi makesList GET /makes/ Returns a list of manufacturers
ws_api_client.MarketsApi marketsList GET /markets/ Returns a list of markets/regions
ws_api_client.ModelsApi modelsList GET /models/ Returns a list of models by manufacturer
ws_api_client.ModelsApi modelsRead GET /models/{make}/{slug}/ Get more info about model
ws_api_client.ModelsApi modelsReadYear GET /models/{make}/{slug}/{year}/ Get more info about model/year
ws_api_client.SearchApi searchByHfTireList GET /search/by_hf_tire/ Find models matching given high flotation tire
ws_api_client.SearchApi searchByModelList GET /search/by_model/ Find OE and option fitments by model/year/trim
ws_api_client.SearchApi searchByRimList GET /search/by_rim/ Find models matching given rim parameters
ws_api_client.SearchApi searchByTireList GET /search/by_tire/ Find models matching given tire parameters
ws_api_client.TiresApi tiresList GET /tires/ Returns a list of tires
ws_api_client.TiresApi tiresRead GET /tires/{tire}/ Model modifications matching given tire
ws_api_client.TrimsApi trimsList GET /trims/ Model modifications
ws_api_client.VehiclesApi vehiclesList GET /vehicles/ Find OE and option fitments by model/year/trim
ws_api_client.YearsApi yearsList GET /years/ Returns list of years for the given manufacturer/model

Documentation for Models

Documentation for Authorization

user_key

  • Type: API key
  • API key parameter name: user_key
  • Location: URL query string