logistics-x/clients-sdk

API client generated from OpenAPI definition from Logistics-X.com

dev-master 2023-01-26 15:38 UTC

Requires

• allansun/openapi-runtime: ^3.0.0

Requires (Dev)

• allansun/openapi-code-generator: ^1.0.0

Apache-2.0

• Allan Sun

README

Code generated from Logistics-X.com's OpenAPI file using allansun/openapi-code-generator.

Generated code is well self-documented with proper PHPDoc annotations.

Please refer to Logistics-X.com's documentation for detailed API behaviour explanation.

Installation

composer require logistics-x/clients-sdk

You will also need a PSR-18 compatible client see https://docs.php-http.org/en/latest/clients.html

So either use Guzzle (or any other PSR-18 compatible clients)

composer require php-http/guzzle7-adapter

Versioning

This project matches Logistics-X's API versioning.

Should you found a matching version not being available. Please contact the author to generate against correct version.

Usage

First you need to create a PSR-18 Then in your business logic you can call API operations directly

<?php
use LogisticsX\Users\Api\User;
$httpClient = new \GuzzleHttp\Client([
    'base_uri' => 'https://www.logistics-x.com/',
    'headers'=>[
        'Authorization'=> 'Bearer <accessToken>'
    ]
]);
$api = new User($httpClient);

$users = $api->getUserCollection();

Author

• Allan Sun - Initial work