Wheel Fitment API Client SDK for PHP
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
lib
test
.php_cs
.swagger-codegen-ignore
.travis.yml
README.md
composer.json
git_push.sh
phpunit.xml.dist

README.md

ws-api-client-php

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 PHP package is automatically generated by the Swagger Codegen project:

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

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/driveate/ws-api-client-php.git"
    }
  ],
  "require": {
    "driveate/ws-api-client-php": "*@dev"
  }
}

Then run composer install

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: user_key
$config = WsApiClient\Configuration::getDefaultConfiguration()->setApiKey('user_key', 'YOUR_API_KEY');

$apiInstance = new WsApiClient\Api\MakesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$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`)

try {
    $result = $apiInstance->makesList(null, null, null, $countries, null);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MakesApi->makesList: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

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

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

Author

info@wheel-size.com