evoliz/evoliz-php

Evoliz PHP Library

v0.7.0 2024-03-25 16:48 UTC

README

Evoliz PHP

PHP Version Require Latest Stable Version Total Downloads License

The Evoliz PHP library provides convenient access to the Evoliz API from applications written in the PHP language. It includes a pre-defined set of classes for API resources that initialize themselves dynamically from API responses which makes it compatible with a wide range of versions of the Evoliz API.

Requirements

PHP 7.0.0 and later.

Composer

You can install the package via Composer. Run the following command:

composer require evoliz/evoliz-php

To use the package, use Composer's autoload:

require_once('vendor/autoload.php');

Dependencies

The package require the following extensions in order to work properly:

If you use Composer, these dependencies should be handled automatically.

Getting Started

Simple usage looks like:

$config = new Evoliz\Client\Config('YOUR_COMPANYID', 'YOUR_PUBLIC_KEY', 'YOUR_SECRET_KEY');
$clientRepository = new ClientRepository($config);

$client = $clientRepository->create(new Client([
    'name' => 'Evoliz',
    'type' => 'Particulier',
    'address' => [
        'postcode' => '83130',
        'town' => 'La Garde',
        'iso2' => 'FR'
    ]
]));

Integration examples

You can find all the examples for each endpoint in the examples folder.

Documentation

See the PHP API docs.

See the API changelog to see all the changes made to the API.

Legacy Version Support

PHP < 7.0.0

If you are using a version earlier than PHP 7.0.0, you need to upgrade your environment to use Evoliz.

Development

Get Composer.

Install dependencies:

composer install

Install dependencies as mentioned above (which will resolve PHPUnit), then you can run the test suite:

./vendor/bin/phpunit

Disable Guzzle SSL verification:

HttpClient::setInstance(['verify' => false], [], true);