Download the PHP package pkge/php-sdk without Composer
On this page you can find all versions of the php package pkge/php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package php-sdk
Order Tracking API - PHP SDK
A single multifunctional API to track packages worldwide from over 850 courier companies and postal services in the desired language.
Library provides convenient access to business.pkge.net api for applications written in PHP language.
Tracking API documentation are available here: https://business.pkge.net/docs
Requirements
PHP 5.4.0 and later.
Installation
Via Composer (https://getcomposer.org/)
Run the following command:
To use SDK, use Composer's autoload:
Getting Started
First, you need initialize api wrapper class with your api key
Responses Metadata
Metadata for last response, such as requests pagination information for some API endpoints, available in getLastResponseMetaData() method:
Entities
All entities used in the SDK and descriptions of their properties, see in /src/Entities
Delivery services endpoints
Access to all delivery services endpoints via couriers property of API object:
All available endpoints methods see in \Pkge\Endpoints\Couriers::class
Packages endpoints
Access to all delivery services endpoints via packages property of API object:
All available endpoints methods see in \Pkge\Endpoints\Packages::class
Webhooks
For handle webhook notifications use \Pkge\Webhook::class.
Example:
Exceptions
In some cases, exceptions may occur when making API requests via the SDK. Their description is given below. For more information about what exceptions a particular method can throw, see the PHPDoc comments on this method.
\Pkge\Exceptions\ApiBadKeyException- Invalid API key specified. How to get API key, see here.\Pkge\Exceptions\ApiCouriersNotDetectedException- Failed to automatically identify the delivery service for the given tracking number.\Pkge\Exceptions\ApiMaxPackagesAmountUpdatingNowException- Failed to update the package. The maximum number of packages allowed is currently being updated. Wait for the next package to complete the update and repeat the request.\Pkge\Exceptions\ApiPackageCannotBeUpdatedException- Failed to update the package. Not enough time has passed since the last update, or the package has already been delivered. Followed by the date of the next possible update in 'payload' if an update is possible.\Pkge\Exceptions\ApiPackagesLimitExceededException- You've reached your plan's limit for adding packages for the billing period.\Pkge\Exceptions\ApiRequestRateLimitException- Limit for requests per second exceeded.\Pkge\Exceptions\ApiTrackNumberExistsException- Tracking number has already been added.\Pkge\Exceptions\ApiWrongCourierIdException- Invalid delivery service ID specified.\Pkge\Exceptions\ApiWrongTrackNumberException- Invalid or unsupported tracking number format.\Pkge\Exceptions\ApiRequestValidationException- Error validating data sent by POST request. See validation errors descriptions ingetValidationErrors()method of exception.\Pkge\Exceptions\ApiRequestException- General or unknown request error. For a description, see thegetMessage()method.
Example
Example demo code see in examples/demo.php. Run:
