UK Vehicle Data
A Ruby wrapper for the UK Vehicle Data API.
Installation
Add module to your Gemfile:
gem 'uk_vehicle_data'
Then run bundle to install the Gem:
bundle install
Set up an initializer file with your UK Vehicle Data API key:
UkVehicleData.api_key = 'uk_vehicle_data_api_key'
e.g. config/initializers/uk_vehicle_data.rb
Usage
This gem provides access to a collection of data packages within the UK Vehicle Data API.
VehicleData
Retrieve vehicle data via VRM.
UkVehicleData::VehicleData.retrieve(params)
Example:
UkVehicleData::VehicleData.retrieve(key_VRM: 'MA58TRX')
BatteryData
Retrieve battery data via VRM.
UkVehicleData::BatteryData.retrieve(params)
MotHistoryAndTaxStatusData
Retrieve MOT history and tax status data via VRM.
UkVehicleData::MotHistoryAndTaxStatusData.retrieve(params)
MotHistoryData
Retrieve MOT history data via VRM.
UkVehicleData::MotHistoryData.retrieve(params)
On request API key
This gem allows you to set the api key on a per request basis.
UkVehicleData::VehicleData.retrieve(key_VRM: 'AX04DHA', auth_apikey: 'custom_api_key')
Versioning
UK Vehicle Data Ruby wrapper follows Semantic Versioning 2.0 as defined at http://semver.org.
How to contribute
- Fork the project
- Create your feature or bug fix
- Add the requried tests for it.
- Commit (do not change version or history)
- Send a pull request against the development branch
Copyright
Copyright (c) 2018 Tom Dallimore (@tom_dallimore)
Licenced under the MIT licence.