Download the PHP package claassenmarius/laravel-skynet without Composer
On this page you can find all versions of the php package claassenmarius/laravel-skynet. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download claassenmarius/laravel-skynet
More information about claassenmarius/laravel-skynet
Files in claassenmarius/laravel-skynet
Package laravel-skynet
Short Description A laravel package to use the Skynet Courier API
License MIT
Informations about the package laravel-skynet
Laravel Skynet
A Laravel package to use the Skynet Courier API.
Installation
Require the package using composer:
Usage
Add the following environment variables to your .env
file and add your Skynet account username, password, system id and account number.
You can obtain an instance of Claassenmarius\LaravelSkynet\Skynet
in any of the following ways:
Type-hinting / Dependency injection
When type-hinting Skynet
in a method, Laravel will automatically resolve it from the IOC container for you.
Facade
You can use the Skynet
Facade.
Manually resolving it from the IOC container
Manual instantiation
If you plan on instantiating Skynet
manually throughout your project it won't be neccessary to add your Skynet credentials to the .env
file. Instead, pass
your credentials to the constructor.
The following methods are available to validate a suburb/postcode combination, get a list of postal
codes for a suburb, obtain a POD image and
track a waybill. Each method returns a new Illuminate\Http\Client\Response
which
exposes methods to inspect the response.
Get a security token
Validate a suburb and postal code combination
Get a list of postal codes for a suburb
Get a quote for a parcel
Get ETA between two locations
Generate a waybill
Get a waybill POD Image
Track a waybill
Response
Illuminate\Http\Client\Response
provides the following methods to inspect the response.
Get the body of the response as a string:
Get the JSON decoded body of the response as an array or scalar value (if a $key is passed in)
Get the JSON decoded body of the response as an object.
Get the JSON decoded body of the response as a collection.
Get a header from the response.
Get the headers from the response.
Get the status code of the response.
Determine if the request was successful (Whether status code >=200
& <300
)
Determine if the response code was "OK". (Status code === 200
)
Determine if server error occurred. (Whether status code >=500
)
Determine if client or server error occurred.
You can inspect the Laravel documentation for more information on the methods that Illuminate\Http\Client\Response
provide.
Exception Handling
This package uses Laravel's Http Client behind the scenes, which does not throw exceptions on client or server errors (400 and 500 level responses from servers). You may determine if one of these errors was returned using the successful, clientError, or serverError methods.
If you have a response instance and would like to throw an instance of Illuminate\Http\Client\RequestException
if the response status code indicates a client or
server error, you may use the throw method:
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
License
The MIT Licence (MIT). Please see Licence File for more information.