wpify/dpd-geo-php-sdk
Composer 安装命令:
composer require wpify/dpd-geo-php-sdk
包简介
This documentations describes what the GeoAPI is and how to use it properly. **What is GeoAPI** The GeoAPI allows DPD customers to manage (CRUD) their shipments and shipment related data. The main purpose of the API is to provide the customer the means for: - Creating and managing new shipment
README 文档
README
This documentations describes what the GeoAPI is and how to use it properly.
What is GeoAPI
The GeoAPI allows DPD customers to manage (CRUD) their shipments and shipment related data.
The main purpose of the API is to provide the customer the means for:
- Creating and managing new shipments
- Ordering pickups for parcels
- Printing parcel labels
- Listing all available shipping services
- Validating shipping routes
It also provides methods for listing your pickup addresses and the details of individual parcels.
Each user is assigned a user account under which he is able to track multiple customer DSWs (customer numbers).
You as a customer can use a single GeoAPI account to send shipments under multiple DPD customer numbers.
For more information, please visit https://www.dpd.com/cz/cs/.
Installation & Usage
Requirements
PHP 7.4 and later. Should also work with PHP 8.0.
Composer
To install the bindings via Composer, add the following to composer.json:
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/wpify/dpd-geo-php-sdk.git"
}
],
"require": {
"wpify/dpd-geo-php-sdk": "*@dev"
}
}
Then run composer install
Manual Installation
Download the files and include autoload.php:
<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');
Getting Started
Please follow the installation procedure and then run the following:
<?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 Endpoints
All URIs are relative to https://geoapi.dpd.cz/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| DefaultApi | countriesGet | GET /countries | List all available countries for your account |
| DefaultApi | customersCustomerDSWAddressesGet | GET /customers/{customerDSW}/addresses | List all addresses associated with the specified customer |
| DefaultApi | customersGet | GET /customers | List all customers associated with the active user account |
| DefaultApi | meGet | GET /me | Get the active customers of the user account and their list of addresses. |
| DefaultApi | parcelsGet | GET /parcels | List all parcels for the current active user account |
| DefaultApi | parcelsLabelsPost | POST /parcels/labels | Print the labels for multiple parcels |
| DefaultApi | parcelsParcelIdentLabelsPost | POST /parcels/{parcelIdent}/labels | Print the parcel labels |
| DefaultApi | parcelsParcelNoTrackingGet | GET /parcels/{parcelNo}/tracking | Get parcel tracking info |
| DefaultApi | parcelsTrackingPost | POST /parcels/tracking | Get the tracking info for multiple parcels |
| DefaultApi | pickupOrdersPickupOrderIdDelete | DELETE /pickup-orders/{pickupOrderId} | Cancel pickup order by pickupOrderId |
| DefaultApi | pickupOrdersPickupOrderIdGet | GET /pickup-orders/{pickupOrderId} | Show information about a specific pickup order. |
| DefaultApi | pickupOrdersPost | POST /pickup-orders | Create a new pickup order. |
| DefaultApi | shipmentsPost | POST /shipments | Create new shipments |
| DefaultApi | shippingServicesGet | GET /shipping-services | List of all available shipping services in JSON. |
Models
- A4PrintProperties
- A6PrintProperties
- Account
- AccountInternational
- Address
- Address1
- AddressPickupOrderSpecs
- ArbitraryAddressPickupOrderSpecs
- ArbitraryAddressPickupOrderSpecsArbitraryAddress
- CashOnDeliveryService
- CashOnDeliveryWithAccount
- CollectionPickupOrderResponse
- Completeness
- Country
- CountryCodInfo
- CountryIdent
- CountryIdentOneOf
- CountryIdentOneOf1
- CountryIdentOneOf2
- Customer
- CustomerAddress
- CustomerAddressAddress
- CustomerAddressIdent
- CustomerAddressIdentOneOf
- CustomerAddressIdentOneOf1
- CustomerIdent
- CustomerIdentOneOf
- CustomerIdentOneOf1
- DPDTimeGuaranteeService
- DeclaredSender
- DeletePickupOrder
- DeliveryOptions
- DepartmentDeliveryService
- Depot
- DispatchDepot
- DispatchDepotDepotNumbers
- Error
- IDCheck
- Insurance
- InsuranceInput
- InsuranceInputAllOf
- LabelData
- LabelDataCod
- LabelDataDelivery
- LabelDataDeliveryPickupPoint
- LabelDataOrigin
- LabelDataOriginSender
- LabelDataParcel
- LabelDataParcelReferences
- LabelDataService
- LabelScriptOrRaw
- Me
- MeCustomersInner
- NewPickupOrder
- NewShipment
- NewShipmentCustomer
- NewShipmentParcelsInner
- NewShipmentParcelsInnerAdditionalServices
- NewShipmentServices
- PDFPrintTypeBatchInput
- PDFPrintTypeInput
- PDFPrintTypeInputPrintProperties
- Parcel
- ParcelEvent
- ParcelEventParcelEventsInner
- ParcelEventParcelEventsInnerService
- ParcelEventParcelEventsInnerStatus
- ParcelEventParcelInfo
- ParcelEventParcelInfoRouting
- ParcelEventParcelInfoServiceDesignation
- ParcelEventParcelInfoServiceDesignationAllOf
- ParcelIdent
- ParcelIdentOneOf
- ParcelIdentOneOf1
- ParcelNumbers
- ParcelPickupOrderSpecs
- ParcelReferences
- ParcelsLabelsPostRequest
- ParcelsParcelIdentLabelsPostParcelIdentParameter
- ParcelsParcelIdentLabelsPostRequest
- ParcelsTrackingPostRequest
- Payer
- PayerSpecs
- PayerSpecsCustomerAddress
- PaymentType
- PersonalIdentificationService
- PickupOrder
- PickupOrderSpecs
- PickupOrdersPickupOrderIdDelete200Response
- PickupPointService
- PrintType
- Receiver
- ReceiverSpecs
- Routing
- RoutingData
- RoutingDataDestinationDepot
- RoutingDataDestinationDepotDepotNumbers
- Sender
- SenderSpecs
- ServiceDesignation
- Shipment
- ShipmentExample
- ShipmentReferences
- ShipmentServices
- ShipmentServicesSelectedServices
- ShipmentType
- ShippingService
- ShippingServiceBackVariant
- ShippingServiceLimitations
- ShippingServiceLimitationsCountryLimitations
- ShippingServiceLimitationsCountryLimitationsOrigin
- ShippingServiceLimitationsCountryLimitationsOriginCountries
- ShippingServiceLimitationsMpsDisabled
- ShippingServiceLimitationsMpsDisabledOneOf
- ShippingServiceLimitationsMpsDisabledOneOfTimeFramesInner
- ShippingServiceLimitationsRequiredContactInfo
- ShippingServiceLimitationsWeightLimit
- ShippingServiceList
- SimpleID
- Source
- StandardPrintTypeBatchInput
- StandardPrintTypeBatchInputAllOf
- StandardPrintTypeInput
- StatusCode
- SubjectInfo
- SubjectInfoContact
- UserAccount
Authorization
ApiKeyAuth
- Type: API key
- API key parameter name: x-api-key
- Location: HTTP header
Tests
To run the tests, use:
composer install
vendor/bin/phpunit
Author
info@dpd.cz
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
1.0.0 - Build package:
org.openapitools.codegen.languages.PhpClientCodegen
wpify/dpd-geo-php-sdk 适用场景与选型建议
wpify/dpd-geo-php-sdk 是一款 基于 PHP 开发的 Composer 扩展包,目前已累计 20 次下载、GitHub Stars 达 0, 最近一次更新时间为 2023 年 07 月 13 日, 在 PHP 生态内属于活跃度较高的组件。
它主要适用于以下技术方向: 「php」 「rest」 「api」 「sdk」 「openapi」 「openapitools」 等业务场景。在实际项目中,围绕这些方向常见需要落地的问题包括:接口对接、性能调优、并发安全、与既有框架(Laravel / ThinkPHP / Yii / Webman 等)的兼容适配,以及生产环境的日志埋点与稳定性保障。
我们在过去多个企业项目中使用过 wpify/dpd-geo-php-sdk 或与其功能相近的方案,如果你在选型或落地过程中遇到问题,例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查,欢迎联系我们协助评估。
基于 wpify/dpd-geo-php-sdk 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。
线上偶发问题、内存泄漏、慢查询、并发异常等排查修复;针对高流量场景做缓存、队列、索引层面的调优。
承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维;也可按月提供技术保姆服务。
与 wpify/dpd-geo-php-sdk 相关的其它包
同方向 / 同关键字的高下载量 PHP Composer 包推荐,方便对比选型:
A PSR-7 compatible library for making CRUD API endpoints
Api bundle
Alfabank REST API integration
A Flickr wrapper to allow you to call the Flickr api with Guzzle as the backend.Goal is to have 100% Flickr api coverage rather than just upload/display photos (currently at 23%).
BlockCypher's PHP SDK for REST API
Helper classes for creating cookie headers
统计信息
- 总下载量: 20
- 月度下载量: 0
- 日度下载量: 0
- 收藏数: 0
- 点击次数: 16
- 依赖项目数: 0
- 推荐数: 0
其他信息
- 授权协议: unlicense
- 更新时间: 2023-07-13