Download the PHP package alopeyk/alopeyk-api-php without Composer
On this page you can find all versions of the php package alopeyk/alopeyk-api-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download alopeyk/alopeyk-api-php
More information about alopeyk/alopeyk-api-php
Files in alopeyk/alopeyk-api-php
Informations about the package alopeyk-api-php
AloPeyk/AloPeyk-Api-PHP
This package is built to facilitate application development for AloPeyk RESTful API. For more information about this api, please visit AloPeyk Documents
Installation
First of all, You need an ACCESS-TOKEN. All Alopeyk API endpoints support the JWT authentication protocol. To start sending authenticated HTTP requests you will need to use your JWT authorization token which is sent to you. Then you can install this package by using Composer, running this command:
Link to Packagist: https://packagist.org/packages/alopeyk/alopeyk-api-php
Usage
1. Authenticate
Sample Api Response
2. Get Address
This endpoint retrieves place information by its latitude and longitude.
Sample Api Response
3. Location Suggestions
This endpoint retrieves suggestions by search input. The result will be an array of suggestions. Each one includes the region and the name of the retrieved place, and offers coordinates for that item.
Sample Api Response
4. Get Price
Request a quote for an order with origin address and destination address.
Sample Api Response
5. Create Order
Once you calculated your the price of your order, you can use this endpoint in order to create a new order.
Sample Api Response
6. Get Order Detail
In order to get the order details, call this method.
Sample Api Response
7. Cancel Order
You can cancel any order before courier arrival (before the accepted status)
Sample Api Response
8. Get Batch Price
This endpoint is the same as Normal Price But the difference is you can calculate up to 15 pairs of Normal Price in one request.
License
This package is released under the MIT license.
Copyright (c) 2012-2017 Markus Poerschke
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.