Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

ws-api-client-ruby

WsApiClient - the Ruby gem for the Wheel Fitment API

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.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build ws-api-client-ruby.gemspec

Then either install the gem locally:

gem install ./ws-api-client-ruby-1.0.0.gem

(for development, run gem install --dev ./ws-api-client-ruby-1.0.0.gem to install the development dependencies).

Finally add this to the Gemfile:

gem 'ws-api-client-ruby', '~> 1.0.0'

Install from Git

Add the following in the Gemfile:

gem 'ws-api-client-ruby', :git => 'https://github.com/driveate/ws-api-client-ruby.git'

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'ws-api-client-ruby'

# Setup authorization
WsApiClient.configure do |config|
  # Configure API key authorization: user_key
  config.api_key['user_key'] = 'YOUR API KEY'
end

api_instance = WsApiClient::MakesApi.new

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`)
}

begin
  #Get list manufacturers
  result = api_instance.makes_list(opts)
  p result
rescue WsApiClient::ApiError => e
  puts "Exception when calling MakesApi->makes_list: #{e}"
end

Documentation for API Endpoints

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

Class Method HTTP request Description
WsApiClient::BoltPatternsApi bolt_patterns_list GET /bolt-patterns/ Get list of bolt patterns
WsApiClient::BoltPatternsApi bolt_patterns_read GET /bolt-patterns/{bolt_pattern}/ Model modifications by bolt pattern
WsApiClient::CountriesApi countries_list GET /countries/ Returns a list of countries
WsApiClient::GenerationsApi generations_list GET /generations/ Generations for the given model
WsApiClient::MakesApi makes_list GET /makes/ Returns a list of manufacturers
WsApiClient::MarketsApi markets_list GET /markets/ Returns a list of markets/regions
WsApiClient::ModelsApi models_list GET /models/ Returns a list of models by manufacturer
WsApiClient::ModelsApi models_read GET /models/{make}/{slug}/ Get more info about model
WsApiClient::ModelsApi models_read_year GET /models/{make}/{slug}/{year}/ Get more info about model/year
WsApiClient::SearchApi search_by_hf_tire_list GET /search/by_hf_tire/ Find models matching given high flotation tire
WsApiClient::SearchApi search_by_model_list GET /search/by_model/ Find OE and option fitments by model/year/trim
WsApiClient::SearchApi search_by_rim_list GET /search/by_rim/ Find models matching given rim parameters
WsApiClient::SearchApi search_by_tire_list GET /search/by_tire/ Find models matching given tire parameters
WsApiClient::TiresApi tires_list GET /tires/ Returns a list of tires
WsApiClient::TiresApi tires_read GET /tires/{tire}/ Model modifications matching given tire
WsApiClient::TrimsApi trims_list GET /trims/ Model modifications
WsApiClient::VehiclesApi vehicles_list GET /vehicles/ Find OE and option fitments by model/year/trim
WsApiClient::YearsApi years_list 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

About

Wheel Fitment API Client SDK for Ruby on Rails

Resources

Releases

No releases published

Packages

No packages published