Download the PHP package smart-dato/sf-express-sdk without Composer
On this page you can find all versions of the php package smart-dato/sf-express-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download smart-dato/sf-express-sdk
More information about smart-dato/sf-express-sdk
Files in smart-dato/sf-express-sdk
Package sf-express-sdk
Short Description SF Express international open API SDK for Laravel
License MIT
Homepage https://github.com/smart-dato/sf-express-sdk
Informations about the package sf-express-sdk
SF Express SDK
A Laravel package for the SF Express international open API. It creates shipments, queries order details and fetches tracking, handling the API's AES message encryption and request signing for you.
Requirements
- PHP 8.2+
- Laravel 10 – 13
- The
opensslPHP extension
Installation
Publish the config file:
https://api-ifsp-sit.sf.global is SF's SIT (sandbox) environment.
Usage
The SfExpress facade uses the configured credentials:
Or construct the client yourself; any argument you leave out falls back to the config:
The client fetches its access token from /openapi/api/token on the first API call, not when it is constructed. SfExpressGenericException is thrown if SF rejects the credentials.
Every method takes the request as a JSON string. The payload classes build that string for you with toJson().
Create a shipment
Sends an IUOP_CREATE_ORDER message.
ShipmentPayload also accepts pickup, customs, extended-info and added-service details — see its constructor for the full list.
Query shipment details
Sends an IUOP_QUERY_ORDER message.
Track a shipment
Sends a GTS_QUERY_TRACK message.
Each method returns the decrypted response decoded into an array. A non-zero apiResultCode from SF raises SfExpressGenericException with the code and message.
Testing
The tests that call SF's sandbox are skipped by default, since they need real credentials.
Changelog
Please see CHANGELOG for more information on what has changed recently.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- SmartDato
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of sf-express-sdk with dependencies
spatie/laravel-package-tools Version ^1.16
illuminate/contracts Version ^10.0||^11.0||^12.0||^13.0
ext-openssl Version *