Download the PHP package isetdev/colibri-shipper-sdk-php without Composer
On this page you can find all versions of the php package isetdev/colibri-shipper-sdk-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download isetdev/colibri-shipper-sdk-php
More information about isetdev/colibri-shipper-sdk-php
Files in isetdev/colibri-shipper-sdk-php
Package colibri-shipper-sdk-php
Short Description This is the official PHP SDK for Integration with FretEasy API. https://www.freteasy.com.br
License MIT
Homepage https://www.freteasy.com.br
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 colibri-shipper-sdk-php
Getting started
This is the official PHP SDK for Integration with FretEasy API. https://www.freteasy.com.br
How to Build
The generated code has dependencies over external libraries like UniRest. These dependencies are defined in the file that comes with the SDK. To resolve these dependencies, we use the Composer package manager which requires PHP greater than 5.3.2 installed in your system. Visit https://getcomposer.org/download/ to download the installer file for Composer and run it in your system. Open command prompt and type . This should display the current version of the Composer installed if the installation was successful.
- Using command line, navigate to the directory containing the generated files (including ) for the SDK.
- Run the command . This should install all the required dependencies and create the directory in your project directory.
[For Windows Users Only] Configuring CURL Certificate Path in php.ini
CURL used to include a list of accepted CAs, but no longer bundles ANY CA certs. So by default it will reject all SSL certificates as unverifiable. You will have to get your CA's cert and point curl at it. The steps are as follows:
- Download the certificate bundle (.pem file) from https://curl.haxx.se/docs/caextract.html on to your system.
- Add curl.cainfo = "PATH_TO/cacert.pem" to your php.ini file located in your php installation. “PATH_TO” must be an absolute path containing the .pem file.
How to Use
The following section explains how to use the Freteasy library in a new project.
1. Open Project in an IDE
Open an IDE for PHP like PhpStorm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.
Click on in PhpStorm to browse to your generated SDK directory and then click .
2. Add a new Test Project
Create a new directory by right clicking on the solution name as shown below:
Name the directory as "test"
Add a PHP file to this project
Name it "testSDK"
Depending on your project setup, you might need to include composer's autoloader in your PHP code to enable auto loading of classes.
It is important that the path inside require_once correctly points to the file inside the vendor directory created during dependency installations.
After this you can add code to initialize the client library and acquire the instance of a Controller class. Sample code to initialize the client library and using controller methods is given in the subsequent sections.
3. Run the Test Project
To run your project you must set the Interpreter for your project. Interpreter is the PHP engine installed on your computer.
Open from menu.
Select from within
Browse for Interpreters near the option and choose your interpreter.
Once the interpreter is selected, click
To run your project, right click on your PHP file inside your Test project and click on
How to Test
Unit tests in this SDK can be run using PHPUnit.
- First install the dependencies using composer including the
require-devdependencies. - Run
vendor\bin\phpunit --verbosefrom commandline to execute tests. If you have installed PHPUnit globally, run tests usingphpunit --verboseinstead.
You can change the PHPUnit test configuration in the phpunit.xml file.
Initialization
Authentication
In order to setup authentication and initialization of the API client, you need the following information.
| Parameter | Description |
|---|---|
| xApiKey | API Key (Request to Dev Team) |
API client can be initialized as following.
Class Reference
List of Controllers
- QuoteController
- AddressController
QuoteController
Get singleton instance
The singleton instance of the class can be accessed from the API Client.
getQuote
Endpoint to verify if all services still working fine
Example Usage
createQuote
Endpoint to get quotation freight according to sender, destiny and items for each service
Parameters
| Parameter | Tags | Description |
|---|---|---|
| quote | quote input to calculate freight |
Example Usage
Back to List of Controllers
AddressController
Get singleton instance
The singleton instance of the class can be accessed from the API Client.
getByPostcode
Endpoint to get address by country and postcode
Parameters
| Parameter | Tags | Description |
|---|---|---|
| country | country abbreviation to search address | |
| postcode | postcode number |
Example Usage
Back to List of Controllers
All versions of colibri-shipper-sdk-php with dependencies
ext-curl Version *
ext-json Version *
ext-mbstring Version *
apimatic/unirest-php Version ^2.0.0
apimatic/jsonmapper Version ^1.3.1