codebyray / laravel-vehapi
车辆信息API Laravel包
Requires
- php: ^7.3|^8.0
- illuminate/support: ^7.0|^8.0
Requires (Dev)
- orchestra/testbench: ^6.0
- phpunit/phpunit: ^9.5
This package is auto-updated.
Last update: 2024-09-21 11:09:10 UTC
README
车辆信息API是一个API系统,用于检索车辆信息,包括车辆年份、制造商、型号、车型、变速器、引擎以及车辆制造商的标志。有关此服务的更多信息或订阅,请访问 车辆信息API
注意:此包目前仅用于从我们的API检索车辆数据,它无法从我们的MOTO API端点检索任何数据。我们将在未来的版本中添加该功能。
安装
您可以通过composer安装此包
composer require codebyray/laravel-vehapi
然后,在您的 app/config/app.php
中包含服务提供者。
注意:如果您正在运行Laravel 5.5+,这将为您自动加载。
'providers' => [ Codebyray\LaravelVehapi\LaravelVehapiServiceProvider::class ];
发布配置文件(可选)
php artisan vendor:publish --provider="Codebyray\LaravelVehapi\LaravelVehapiServiceProvider" --tag="config"
设置 .env 文件
将您的API令牌、API版本和API SSL检查添加到您的 .env 文件中
注意:API版本默认为v1,除非您正在使用Vehicle Info API的不同版本,否则您无需指定版本。API令牌是必需的。但是,它可以输入到您的 .env 文件中(推荐),或发布的配置文件中。
VEH_API_TOKEN=YOUR_VEH_API_TOKEN VEH_API_VERSION=v1 VEH_CHECK_SSL_CERT=true // Defaults to true. Change to false if testing locally.
使用方法
让我们获取所有制造商的所有不同年份
/** * @param string $sort - optional, defaults to 'asc' */ LaravelVehapi::getAllYears($sort = 'asc'); // Returns associative array // This will return all years from 1899-2022 $vehYears = LaravelVehapi::getAllYears($sort); // Convert array to json format $vehYears = json_encode(LaravelVehapi::getAllYears($sort));
让我们获取所有制造商的所有不同年份
/** * @param int $minYear - required * @param int $maxYear - required * @param string $sort - optional, defaults to 'asc' */ LaravelVehapi::getYearsRange(int $minYear, int $maxYear, $sort = 'asc'); // Returns associative array $vehYears = LaravelVehapi::getYearsRange('2010', '2014', 'desc'); // Convert array to json format $vehYears = json_encode(LaravelVehapi::getYearsRange('2010', '2014', 'desc'));
让我们获取所有可用的制造商
/** * @param string $sort - optional, defaults to 'asc' */ LaravelVehapi::getAllMakes($sort = 'asc'); // Returns associative array $vehMakes = LaravelVehapi::getAllMakes(); // Convert array to json format $vehMakes = json_encode(LaravelVehapi::getAllMakes());
让我们获取特定年份所有可用的制造商
/** * @param int $year - required * @param string $sort - optional, defaults to 'asc' */ LaravelVehapi::getMakesByYear($year, $sort = 'asc'); // Returns associative array $vehMakes = LaravelVehapi::getMakesByYear(2015); // Convert array to json format $vehMakes = json_encode(LaravelVehapi::getMakesByYear(2015));
让我们获取特定年份范围内所有可用的制造商
/** * @param int $minYear - required * @param int $maxYear - required * @param string $sort - optional, defaults to 'asc' */ LaravelVehapi::getMakesByYearsRange($minYear, $maxYear, $sort = 'asc'); // Returns associative array $vehMakes = LaravelVehapi::getMakesByYear(2015); // Convert array to json format $vehMakes = json_encode(LaravelVehapi::getMakesByYear(2015));
让我们获取特定制造商所有可用的型号
/** * @param string $make - required * @param string $sort - optional, defaults to 'asc' */ LaravelVehapi::getAllModelsByMake($make, $sort = 'asc'); // Returns associative array $vehModels = LaravelVehapi::getAllModelsByMake('Acura'); // Convert array to json format $vehModels = json_encode(LaravelVehapi::getAllModelsByMake('Acura'));
让我们获取特定年份和制造商所有可用的型号
/** * @param int $year - required * @param string $make - required * @param string $sort - optional, defaults to 'asc' */ LaravelVehapi::getModelsByYearAndMake($year, $make, $sort = 'asc'); // Returns associative array $vehModels = LaravelVehapi::getModelsByYearAndMake(2015, 'Acura'); // Convert array to json format $vehModels = json_encode(LaravelVehapi::getModelsByYearAndMake(2015, 'Acura'));
让我们获取特定年份、制造商和型号所有可用的车型级别
/** * @param int $year - required * @param string $make - required * @param string $model - required */ LaravelVehapi::getTrimsByYearMakeAndModel($year, $make, $model); // Returns associative array $vehTrims = LaravelVehapi::getTrimsByYearMakeAndModel(2015, 'Acura', 'MDX'); // Convert array to json format $vehTrims = json_encode(LaravelVehapi::getTrimsByYearMakeAndModel(2015, 'Acura', 'MDX'));
让我们获取特定年份、制造商、型号、车型级别和变速器所有可用的变速器
/** * @param int $year - required * @param string $make - required * @param string $model - required * @param string $trim - required */ LaravelVehapi::getTransmissionsByYearMakeModelAndTrim($year, $make, $model, $trim); // Returns associative array $vehTransmissions = LaravelVehapi::getTransmissionsByYearMakeModelAndTrim(2015, 'Acura', 'MDX', 'FWD'); // Convert array to json format $vehTransmissions = json_encode(LaravelVehapi::getTransmissionsByYearMakeModelAndTrim(2015, 'Acura', 'MDX', 'FWD'));
让我们获取特定年份、制造商、型号、车型级别、变速器和引擎所有可用的引擎
/** * @param int $year - required * @param string $make - required * @param string $model - required * @param string $trim - required * @param string $transmission - required */ LaravelVehapi::getEnginesByYearMakeModelTrimAndTransmission($year, $make, $model, $trim, $transmission); // Returns associative array $vehEngines = LaravelVehapi::getEnginesByYearMakeModelTrimAndTransmission(2015, 'Acura', 'MDX', 'FWD', '6-Speed Automatic'); // Convert array to json format $vehEngines = json_encode(LaravelVehapi::getEnginesByYearMakeModelTrimAndTransmission(2015, 'Acura', 'MDX', 'FWD', '6-Speed Automatic'));
让我们获取特定年份、制造商、型号、车型级别、变速器、引擎所有可用的轮子选项
/** * Return wheels available for the year, make, model, transmission & engine supplied. * * @param int $year * @param string $make * @param string $model * @param string $trim * @param string $transmission * @param string $engine * * @return mixed */ LaravelVehapi::getWheelsByYearMakeModelTrimTransmissionAndEngine($year, $make, $model, $trim, $transmission, $engine); // Returns associative array $vehWheels = LaravelVehapi::getWheelsByYearMakeModelTrimTransmissionAndEngine(2021, 'Acura', 'TLX', 'FWD', '10-Speed Automatic', '2.0L 272 hp I4'); // Convert array to json format $vehWheels = json_encode(LaravelVehapi::getWheelsByYearMakeModelTrimTransmissionAndEngine(2021, 'Acura', 'TLX', 'FWD', '10-Speed Automatic', '2.0L 272 hp I4'));
让我们获取特定年份、制造商、型号、车型级别、变速器、引擎所有可用的车辆选项
/** * Return options available for the year, make, model, transmission & engine supplied. * * @param int $year * @param string $make * @param string $model * @param string $trim * @param string $transmission * @param string $engine * * @return mixed */ LaravelVehapi::getOptionsByYearMakeModelTrimTransmissionAndEngine($year, $make, $model, $trim, $transmission, $engine); // Returns associative array $vehOptions = LaravelVehapi::getOptionsByYearMakeModelTrimTransmissionAndEngine(2021, 'Acura', 'TLX', 'FWD', '10-Speed Automatic', '2.0L 272 hp I4'); // Convert array to json format $vehOptions = json_encode(LaravelVehapi::getOptionsByYearMakeModelTrimTransmissionAndEngine(2021, 'Acura', 'TLX', 'FWD', '10-Speed Automatic', '2.0L 272 hp I4'));
更新日志
请参阅 CHANGELOG 以获取有关最近更改的更多信息。
API文档
有关所有可用API端点的完整列表,请访问 API文档
安全
如果您发现任何与安全相关的问题,请通过电子邮件 dev@codebyray.com 联系我们,而不是使用问题跟踪器。
鸣谢
许可证
MIT许可证(MIT)。有关更多信息,请参阅 许可证文件