bc-consulting/tuning-api-client

Tuning Api Client

Maintainers

Details

github.com/bc-automotive/tuning-api-client

Source

Issues

Installs: 31

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 5

Forks: 0

Open Issues: 0

v1.0.2 2019-12-05 13:18 UTC

Requires

Requires (Dev)

MIT c18a90bcc6398203a8f5cacad68df1c287ba02c3

  • Miguel De Buf <miguel.debuf.woop@orionsoftware.be>

This package is auto-updated.

Last update: 2024-09-06 00:28:22 UTC

README

The bc-consulting/tuning-api-client package is a library that eases integration of the B&C Consulting Tuning database API in your site.

Installation

Install the package via composer:

composer require bc-consulting/tuning-api-client

Usage

Configure the TuningApiClient and use the Models:

use \BcConsulting\TuningApiClient\TuningApiClient;

TuningApiClient::config([
	'api_token' => 'my-token',
	'api_url' => 'https://tuning-api-staging.bcconsulting.lu',
]);
print_r(TuningApiClient::vehicles());
print_r(TuningApiClient::vehicles(1));
print_r(TuningApiClient::vehicles(1)->brands());
print_r(TuningApiClient::vehicles(1)->brands(5));
print_r(TuningApiClient::vehicles(1)->brands(5)->models());
print_r(TuningApiClient::vehicles(1)->brands(5)->models(5359));
print_r(TuningApiClient::vehicles(1)->brands(5)->models(5359)->years());
print_r(TuningApiClient::vehicles(1)->brands(5)->models(5359)->years(8163));
print_r(TuningApiClient::vehicles(1)->brands(5)->models(5359)->years(8163)->powertrains());
print_r(TuningApiClient::vehicles(1)->brands(5)->models(5359)->years(8163)->powertrains(8165));

In case you have a premium subscription, then you also have access to these methods to retrieve brand logo and miniatures:

print_r(TuningApiClient::vehicles(1)->brands(5)->logo());
print_r(TuningApiClient::vehicles(1)->brands(5)->models(508)->miniature());
print_r(TuningApiClient::vehicles(1)->brands(5)->models(5359)->years(8163)->miniature());
print_r(TuningApiClient::vehicles(1)->brands(5)->models(5359)->years(8163)->powertrains(8165)->miniature());

In case of an error, the api throws a BcConsulting\TuningApiClient\Exceptions\TuningApiException. This exception inherits from \Exception and additionally has these methods :

  • getStatusCode() : returns the HTTP status code received
  • getData() : returns an array with more exception specific details
$e->getMessage()
$e->getCode()
$e->getStatusCode()
$e->getData()

Help and docs

License

MIT