PHPackages                             carvx/sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. carvx/sdk

ActiveLibrary[API Development](/categories/api)

carvx/sdk
=========

SDK for CAR VX web API

1.2.6(2y ago)11.5kPHPPHP >=5.4.0

Since Dec 6Pushed 2y agoCompare

[ Source](https://github.com/carvx/sdk)[ Packagist](https://packagist.org/packages/carvx/sdk)[ RSS](/packages/carvx-sdk/feed)WikiDiscussions master Synced yesterday

READMEChangelogDependenciesVersions (16)Used By (0)

### CAR VX SDK

[](#car-vx-sdk)

Prerequisites
-------------

[](#prerequisites)

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

Installation
------------

[](#installation)

#### Install SDK via Composer

[](#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

[](#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
-----

[](#usage)

### Getting credentials

[](#getting-credentials)

First of all, you should register in . Then please write an email to  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

[](#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 - ,
$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

[](#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

[](#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);

```

2. Create report by search result:

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

```

3. Get report:

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

```

4. Get report due date:

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

```

5. 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.

###  Health Score

32

—

LowBetter than 69% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity22

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity66

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~207 days

Recently: every ~674 days

Total

15

Last Release

961d ago

Major Versions

0.4.0 → 1.0.02016-03-15

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/15997805?v=4)[carvx](/maintainers/carvx)[@carvx](https://github.com/carvx)

---

Top Contributors

[![carvxjp](https://avatars.githubusercontent.com/u/31397940?v=4)](https://github.com/carvxjp "carvxjp (38 commits)")

### Embed Badge

![Health badge](/badges/carvx-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/carvx-sdk/health.svg)](https://phpackages.com/packages/carvx-sdk)
```

###  Alternatives

[exsyst/swagger

A php library to manipulate Swagger specifications

35916.4M7](/packages/exsyst-swagger)[hubspot/api-client

Hubspot API client

24016.2M20](/packages/hubspot-api-client)[pocketmine/bedrock-protocol

An implementation of the Minecraft: Bedrock Edition protocol in PHP

172445.0k14](/packages/pocketmine-bedrock-protocol)[botman/driver-telegram

Telegram driver for BotMan

93459.5k6](/packages/botman-driver-telegram)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)