carvx/sdk

There is no license information available for the latest version (1.2.6) of this package.

SDK for CAR VX web API

1.2.6 2023-11-15 11:32 UTC

Requires

• php: >=5.4.0
• ext-curl: *

Unknown License

• Car VX Limited

README

CAR VX SDK

Prerequisites

• PHP 5.4 and above
• Curl extension with support for OpenSSL
• Composer

Installation

Install SDK via Composer

composer.phar require carvx/sdk

After installing, you need to require Composer's autoloader:

require 'vendor/autoload.php';

Install SDK manually

If you don't use Composer, you can download archive with SDK from GitHub, unpack and require it in your code:

require 'path-to-sdk/src/autoload.php';

Usage

Getting credentials

First of all, you should register in https://carvx.jp. Then please write an email to [e-mail] with your company's name and your site's URL. After we enable API support for your account, you will see the API Settings section in the My Account area of the site. There you will find credentials necessary for SDK usage.

Making requests

You should create object of CarvxService class:

$service = new Carvx\CarvxService($url, $userUid, $apiKey, $options);

where:
$url - the URL of CAR VX system - https://carvx.jp,
$userUid - user unique identifier - available in the API Settings section of the site,
$apiKey - secret key - available in the API Settings section of the site,
$options - optional array with parameters - see below.

Available options

needSignature - boolean - if true, all requests will be complemented with signature (based on request params and $apiKey). If false, with plain $apiKey. Default value - true. It is not recommended to set it to false (you will also need to change settings in the API Settings section of the site).

raiseExceptions - boolean - if true, all exceptions occurred during request will be re-raised so you will be able to handle it manually. All exceptions are of the type of Carvx\Utils\CarvxApiException. If false, all exceptions will be handled internally. Default value - false.

isTest - boolean - if true, all created reports will have test type. It is useful during development and testing stage. All test reports can be found in the My Reports section of the My Account area of the site (with 'Test' type selected). Default value - false.
Test reports will be in completed status right after creation. So you can execute getReport call immediately after receiving report identifier with createReport call.

Request types

With the help of created service object you can make the following requests to CAR VX system:

1. Create search:

$search = $service->createSearch($chassisNumber);

1. Create report by search result:

$reportId = $service->createReport($searchId, $carId);

1. Get report:

$report = $service->getReport($reportId);

1. Get report due date:

$dueDate = $service->getReportDueDate($creationTime);

1. Create report by chassis number:

$report = $service->createReportByChassisNumber($chassisNumber);

After you've created a report it can take for a while for it to be ready. So you can either poll the server periodically or you can set the URL in the API Settings section of the site and you will be notified when the report is ready.