README

DeliveryMatch API 库提供了一个简单的方式连接到我们的 API。

安装

目前有两种方式使用我们的库。您可以在 composer 项目中导入它，或者您可以下载源代码并将其放置在您的项目中。

composer require deliverymatch/api-library

您可以通过我们的 GitHub 页面下载源代码。下载 zip 文件后，需要将其解压缩到您的项目中。

创建一个 DeliveryMatchClient 实例。构造函数需要 3 个参数。这 3 个参数由 DeliveryMatch 提供

use DeliveryMatchApiLibrary\DeliveryMatchClient;

$api = new DeliveryMatchClient($_SERVER["CLIENT_ID"], $_SERVER["API_KEY"], $_SERVER["URL"]);

使用 PHP 数组创建您的请求。您可以在我们的 API 文档中找到每个端点的示例请求。如果您没有收到任何 API 文档，可以由 DeliveryMatch 提供请求。

$requestData = [
    "shipment" => [
        "id" => 12345678
    ]
]

使用 sendRequest 方法发送您的请求。此方法需要两个参数。端点名称和您需要发送的数据。如果您想发送一个空请求，请使用空数组作为参数。

try {
    $api->sendRequest("getShipment", $requestData)''
} catch (DeliveryMatchException $e) {
    // handle error
}

sendRequest 可能会抛出 DeliveryMatchException。异常代码与我们的 API 文档中相应的响应代码相同。