Download the PHP package firewizard/fancourier-api without Composer
On this page you can find all versions of the php package firewizard/fancourier-api. 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 fancourier-api
FANCourier API v2
Table of contents
- Installation
- Requirements
- Composer
- Usage
- Authentication
- Get estimated shipping cost
- Create AWB
- Create AWB in bulk
- Track AWB
- Print AWB
- Print AWB Html
- Delete AWB
- Track AWB in bulk
- Get cities
- Get counties
- Get services
- Features not implemented
- Contributing
- License
Installation
Requirements
- PHP >= 7.0
- ext-curl
- ext-json
Composer
Require the package via composer
Manual
If used without composer, you will need to manually require the autoload.php file
Breaking changes from v1
- removed Auth class
- removed SendsFile trait
- getCities city array keys have changed (county instead of judet, name instead of localitate, exteriorKm instead of km)
- CreateAwbBulk response body is now an array of AWBs instead of an array of CreateAwb response objects
- trackAwb now returns the full events list, as an array, not just the last message
- trackAwbBulk now returns the full events list, as an array, with info about all AWBs in the request. It's up to you to group by AWB
Usage
Authentication
Create a new instance of Fancourier.php supplying the client_id, username and password.
Or you can use the test instance static method:
Caching the auth token
By default, authentication is always called, which means for every regular request, there will be an extra request to obtain the auth token. You can fix this and cache the auth token in your app.
First, you need to create a new class that implements Fancourier\AuthTokenCacheContract:
Then, pass this to the main Fancourier object:
Note: Tokens change every 24 hours according to Fan Courier, so might want to use a lower cache TTL.
Get estimated shipping cost
Request
Response
Create AWB
Request
Response
Create AWB Bulk
Request
Track AWB
Request
Response
Print AWB
Request
Response
Print AWB Html
Request
Response
Delete AWB
Request
Response
Track awb in bulk
Request
Response
Get cities
Request - There's no request for this method
Response - will return an array of cities (and other info)
Get counties
Request - There's no request for this method
Response - will return an array of counties
Get services
Request - There's no request for this method
Response - will return an array with all services
Features not implemented
Feel free to open a pull request for the following features:
- get pudo
- get streets
- external functions
- create carrier request
- delete carrier request
- summary
- get awb tracking events
- bank transfers
- orders functions
- branches
Contributing
Thank you for considering contributing to the Fancourier API, all pull requests are appreciated.
License
Fancourier Api is open-source software licensed under the MIT license.
All versions of fancourier-api with dependencies
ext-curl Version *
ext-json Version *