avtocod/b2b-api-php

PHP package for a working with B2B API service

v4.4.0 2022-01-10 07:05 UTC

Requires

• php: ^7.2|^8.0
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• composer/package-versions-deprecated: ^1.1
• guzzlehttp/guzzle: ^6.0 || ~7.0

Requires (Dev)

• avto-dev/guzzle-url-mock: ^1.5
• fakerphp/faker: ^1.14
• mockery/mockery: ^1.3
• phpstan/phpstan: ^0.12.92
• phpunit/phpunit: ^8.5.4
• vlucas/phpdotenv: ^3.4 || ^4.0 || ^5.0

Suggests

• avtocod/specs: Avtocod project public specifications.

MIT

• Avtocod

• client
• b2b
• avtocod

README

PHP client for B2B API service

Install

Require this package with composer using the following command:

$ composer require avtocod/b2b-api-php "^4.0"

Installed composer is required (how to install composer).

You need to fix the major version of package.

Usage

Before using this package you must have:

• Service user login
• User password
• User domain name
• Report type name

For getting this values contact with our B2B Sale Managers ([e-mail])

Now, let's create B2B API Client instance:

<?php

use Avtocod\B2BApi\Client;
use Avtocod\B2BApi\Settings;
use Avtocod\B2BApi\Tokens\Auth\AuthToken;

$client = new Client(new Settings(AuthToken::generate('username', 'password', 'domain')));

And then we can make next operations (each call will returns an object with server response data):

<?php /** @var \Avtocod\B2BApi\Client $client */

// Test connection
$client->devPing(new \Avtocod\B2BApi\Params\DevPingParams);

// Debug token generation
$client->devToken(new \Avtocod\B2BApi\Params\DevTokenParams('username', 'password'));

// Retrieve information about current user
$client->user(new \Avtocod\B2BApi\Params\UserParams);

// Retrieve balance information for report type
$client->userBalance(new \Avtocod\B2BApi\Params\UserBalanceParams('report_type_uid@domain'));

// Retrieve report types data
$client->userReportTypes(new \Avtocod\B2BApi\Params\UserReportTypesParams);

// Get reports list
$client->userReports(new \Avtocod\B2BApi\Params\UserReportsParams);

// Get report by unique report ID
$client->userReport(new \Avtocod\B2BApi\Params\UserReportParams('report_uid_SOMEIDENTIFIERGOESHERE@domain'));

// Make (generate) report
$client->userReportMake(new \Avtocod\B2BApi\Params\UserReportMakeParams('report_type_uid@domain', 'VIN', 'Z94CB41AAGR323020'));

// Refresh existing report
$client->userReportRefresh(new \Avtocod\B2BApi\Params\UserReportRefreshParams('report_uid_SOMEIDENTIFIERGOESHERE@domain'));

For example, if you want to generate report for A111AA177 (GRZ type), you can:

<?php /** @var \Avtocod\B2BApi\Client $client */

// Make report (this operation is asynchronous)
$report_uid = $client
    ->userReportMake(
        (new \Avtocod\B2BApi\Params\UserReportMakeParams('some_report_uid', 'GRZ', 'A111AA177'))
            ->setForce(true)
            ->setOnUpdateUrl('https://example.com/webhook/updated')
            ->setOnCompleteUrl('https://example.com/webhook/completed')
    )
    ->first()
    ->getReportUid();

// Wait for report is ready
while (true) {
    $user_report_params = (new \Avtocod\B2BApi\Params\UserReportParams($report_uid))->setIncludeContent(false);
    if ($client->userReport($user_report_params)->first()->isCompleted()) {
        break;
    }

    \sleep(1);
}

$content = $client->userReport(new \Avtocod\B2BApi\Params\UserReportParams($report_uid))->first()->getContent();

$vin_code  = $content->getByPath('identifiers.vehicle.vin');   // (string) 'JTMHX05J704083922'
$engine_kw = $content->getByPath('tech_data.engine.power.kw'); // (int) 227

Testing

For package testing we use phpunit framework and docker-ce + docker-compose as develop environment. So, just write into your terminal after repository cloning:

$ make build
$ make latest # or 'make lowest'
$ make test

Changes log

Changes log can be found here.

Support

If you will find any package errors, please, make an issue in current repository.

License

This is open-sourced software licensed under the MIT License.