README

CAR VX SDK

先决条件

PHP 5.4 及以上
支持OpenSSL的Curl扩展
Composer

安装

通过Composer安装SDK

composer.phar require carvx/sdk

安装后，您需要引入Composer的自动加载器

require 'vendor/autoload.php';

手动安装SDK

如果您不使用Composer，可以从GitHub下载包含SDK的存档，解压并在代码中引入它

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

用法

获取凭证

首先，您应该在 https://carvx.jp 上注册。然后，请发送一封电子邮件到 contact@carvx.jp，注明您的公司名称和网站URL。我们为您的账户启用API支持后，您将在网站的“我的账户”区域的“API设置”部分看到。在那里您将找到SDK使用所需的凭证。

发送请求

您应该创建CarvxService类的对象

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

其中
$url - CAR VX系统的URL - https://carvx.jp，
$userUid - 用户唯一标识符 - 可在网站的“API设置”部分找到，
$apiKey - 密钥 - 可在网站的“API设置”部分找到，
$options - 可选参数数组 - 见下文。

可用选项

needSignature - 布尔值 - 如果为true，所有请求都将添加签名（基于请求参数和$apiKey）。如果为false，则使用纯$apiKey。默认值 - true。不建议设置为false（您还需要更改网站“API设置”部分中的设置）。

raiseExceptions - 布尔值 - 如果为true，所有请求过程中发生的异常将被重新抛出，以便您可以手动处理。所有异常都是Carvx\Utils\CarvxApiException类型。如果为false，所有异常都将内部处理。默认值 - false。

isTest - 布尔值 - 如果为true，所有创建的报告都将具有测试类型。这在开发和测试阶段很有用。所有测试报告都可以在“我的账户”区域的“我的报告”部分找到（选择“测试”类型）。默认值 - false。
测试报告将在创建后立即处于完成状态。因此，您可以在收到报告标识符后立即执行getReport调用。

请求类型

使用创建的服务对象，您可以向CAR VX系统发送以下请求

创建搜索

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

通过搜索结果创建报告

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

获取报告

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

获取报告截止日期

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

通过车架号创建报告

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

创建报告后，它可能需要一段时间才能准备好。因此，您可以选择定期轮询服务器，或者您可以在网站的“API设置”部分设置URL，报告准备好时您将收到通知。

carvx / sdk

维护者

详细信息