README

本文档描述了GeoAPI是什么以及如何正确使用它。

什么是GeoAPI

GeoAPI允许DPD客户管理（CRUD）他们的运输和运输相关数据。

API的主要目的是为客户提供以下手段

创建和管理新的运输
为包裹下单取件
打印包裹标签
列出所有可用的运输服务
验证运输路线

它还提供了列出您的取件地址和单个包裹详情的方法。

每个用户都会分配一个用户账户，在该账户下他可以跟踪多个客户的DSW（客户编号）。
作为客户，您可以使用单个GeoAPI账户在多个DPD客户编号下发送运输。

有关更多信息，请访问 https://www.dpd.com/cz/cs/。

安装 & 使用

要求

PHP 7.4及更高版本。也应与PHP 8.0兼容。

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/wpify/dpd-geo-php-sdk.git"
    }
  ],
  "require": {
    "wpify/dpd-geo-php-sdk": "*@dev"
  }
}

然后运行 composer install

手动安装

下载文件并包含autoload.php

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

入门

请按照安装过程进行操作，然后运行以下命令

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



// Configure API key authorization: ApiKeyAuth
$config = DpdGeoSdk\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = DpdGeoSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new DpdGeoSdk\Api\DefaultApi(
    // 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
);

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

API端点

所有URI都相对于 https://geoapi.dpd.cz/v1

类	方法	HTTP请求	描述
DefaultApi	countriesGet	GET /countries	列出与您的账户关联的所有可用国家
DefaultApi	customersCustomerDSWAddressesGet	GET /customers/{customerDSW}/addresses	列出与指定客户关联的所有地址
DefaultApi	customersGet	GET /customers	列出与活动用户账户关联的所有客户
DefaultApi	meGet	GET /me	获取活动用户账户及其地址列表。
DefaultApi	parcelsGet	GET /parcels	列出当前活动用户账户的所有包裹
DefaultApi	parcelsLabelsPost	POST /parcels/labels	打印多个包裹的标签
DefaultApi	parcelsParcelIdentLabelsPost	POST /parcels/{parcelIdent}/labels	打印包裹标签
DefaultApi	parcelsParcelNoTrackingGet	GET /parcels/{parcelNo}/tracking	获取包裹跟踪信息
DefaultApi	parcelsTrackingPost	POST /parcels/tracking	获取多个包裹的跟踪信息
DefaultApi	pickupOrdersPickupOrderIdDelete	DELETE /pickup-orders/{pickupOrderId}	通过取件订单编号取消取件订单
DefaultApi	pickupOrdersPickupOrderIdGet	GET /pickup-orders/{pickupOrderId}	显示特定取件订单的信息。
DefaultApi	pickupOrdersPost	POST /pickup-orders	创建新的取件订单。
DefaultApi	shipmentsPost	POST /shipments	创建新的运输
DefaultApi	shippingServicesGet	GET /shipping-services	JSON中所有可用运输服务的列表。

模型

授权

API密钥认证

类型：API密钥
API密钥参数名称：x-api-key
位置：HTTP头部

测试

要运行测试，请使用

composer install
vendor/bin/phpunit

作者

info@dpd.cz

关于此包

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

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

wpify / dpd-geo-php-sdk

维护者

详细信息