Download the PHP package codebyray/carlistapi-php-sdk without Composer

On this page you can find all versions of the php package codebyray/carlistapi-php-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 codebyray/carlistapi-php-sdk

Informations about the package carlistapi-php-sdk

Car List API PHP SDK

Official PHP SDK for the Car List API.

The Car List API PHP SDK provides a simple, framework-independent interface for accessing the Car List API. It supports Automotive, Powersports, and VIN Decoder endpoints using authenticated requests.

The SDK works with any PHP application, including:

Requirements

Installation

Install the SDK using Composer:

Configuration

Create a new client using your API token.

By default the SDK uses:

Option Default
Base URL https://carlistapi.com/api
API Version v1
Timeout 15 seconds
Connect Timeout 5 seconds
Retries 2 additional attempts for GET connection failures and HTTP 5xx

To customize these values:

VIN decode POST requests are sent once, even when a connection fails or the API returns HTTP 5xx. A successful decode may count against your quota if its response is lost, so the SDK does not retry it automatically.

If upgrading from v0.1.x, handle a failed VIN decode in your application only when another quota-counted attempt is acceptable.

You can pass a PSR-18 HTTP client as the second constructor argument. When using a non-Guzzle client, configure its timeouts and TLS verification on that client; the SDK's transport options are applied to Guzzle clients.

Quick Start

Automotive

Retrieve all supported years.

Retrieve all makes.

Retrieve models.

Retrieve complete vehicle information.

Powersports

Retrieve supported powersports types.

Retrieve available models.

VIN Decoder

Decode a VIN.

Decode using a known model year.

The SDK automatically normalizes VINs by removing spaces, hyphens, and converting letters to uppercase before sending requests.

Responses

Every successful request returns an ApiResponse object.

Retrieve a specific response header.

Error Handling

The SDK throws strongly typed exceptions.

Available exceptions include:

Exception Description
AuthenticationException Invalid or missing API token
AuthorizationException Insufficient permissions
ValidationException Invalid request
NotFoundException Resource not found
RateLimitException Rate limit exceeded
ServerException Server error
TransportException Network or connection failure

API Versioning

The SDK supports configurable API versions.

When a future version of the Car List API becomes available, updating the SDK configuration is all that is required.

User Agent

Requests automatically include a User-Agent identifying the SDK.

Example:

You may override the User-Agent if desired.

Endpoint Coverage

The SDK currently supports:

Automotive

Powersports

VIN Decoder

Documentation

Complete API documentation is available at:

https://carlistapi.com/docs

Support

If you discover a bug or would like to request a feature, please open an issue on GitHub.

GitHub:

https://github.com/codebyray/carlistapi-php-sdk

License

This project is licensed under the MIT License.

All versions of carlistapi-php-sdk with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
guzzlehttp/guzzle Version ^7.8
psr/http-client Version ^1.0
psr/http-message Version ^1.1 || ^2.0
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 codebyray/carlistapi-php-sdk contains the following files

Loading the files please wait ...