logistics-x/shipments-sdk

由Logistics-X.com的OpenAPI定义生成的API客户端

dev-master 2023-04-14 08:51 UTC

This package is auto-updated.

Last update: 2024-09-14 12:10:00 UTC


README

使用Logistics-X.com的OpenAPI文件通过allansun/openapi-code-generator生成的代码。

生成的代码带有良好的自文档,并使用正确的PHPDoc注释。

有关API行为的详细说明,请参阅Logistics-X.com的文档

安装

composer require logistics-x/shipments-sdk

您还需要一个PSR-18兼容的客户端,请参阅https://docs.php-http.org/en/latest/clients.html

因此,您可以使用Guzzle(或其他PSR-18兼容的客户端)

composer require php-http/guzzle7-adapter

版本管理

此项目与Logistics-X的API版本管理相匹配。

如果您发现匹配的版本不可用,请联系作者以生成正确的版本。

使用方法

首先您需要创建一个PSR-18,然后在您的业务逻辑中可以直接调用API操作

<?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();

作者