Download the PHP package carvx/sdk without Composer

On this page you can find all versions of the php package carvx/sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of carvx/sdk

Informations about the package sdk

CAR VX SDK

Prerequisites

Installation

Install SDK via Composer

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

Install SDK manually

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

Usage

Getting credentials

First of all, you should register in https://carvx.jp. Then please write an email to [email protected] 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:

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:

  2. Create report by search result:

  3. Get report:

  4. Get report due date:

  5. Create report by chassis number:

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.

All versions of sdk with dependencies

PHP Build Version
Package Version
Requires php Version >=5.4.0
ext-curl Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package carvx/sdk contains the following files

Loading the files please wait ....