README

Digitrack API

安装与使用

要求

PHP 7.4 及以上版本。也应与 PHP 8.0 兼容。

Composer

要通过 Composer 安装绑定，请在 composer.json 中添加以下内容

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

然后运行 composer install

手动安装

下载文件并包含 autoload.php

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

入门指南

请遵循 安装过程，然后运行以下命令

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure Bearer (JWT) authorization: bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\EventsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$create_event_input = new \OpenAPI\Client\Model\CreateEventInput(); // \OpenAPI\Client\Model\CreateEventInput

try {
    $result = $apiInstance->eventControllerAddEvent($create_event_input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventsApi->eventControllerAddEvent: ', $e->getMessage(), PHP_EOL;
}

API 端点

所有 URI 都是相对于 https://

模型

• CreateEventInput
• CreateOrderInput
• Delete403Response
• Delete404Response
• EventDto
• GetByReference403Response
• GetByReference429Response
• GetByTrackingNumber400Response
• GetByTrackingNumber401Response
• GetByTrackingNumber403Response
• GetByTrackingNumber404Response
• GetByTrackingNumber429Response
• OrderDto
• ProductDto
• ProductInput
• Update400Response
• UpdateOrderInput
• UpdateProductInput

授权

API 定义的认证方案

bearer

• 类型：Bearer 认证（JWT）

测试

要运行测试，使用

composer install
vendor/bin/phpunit

作者

关于此包

此 PHP 包由 OpenAPI Generator 项目自动生成

• API 版本：1.0
• 构建包：org.openapitools.codegen.languages.PhpClientCodegen