Download the PHP package paps-app/paps-php-client without Composer

PHP API Client for Paps

A PHP client for consuming the Paps API.

This client is targeting the API version v2.

Install

Via Composer

The minimum required version of PHP is 5.6

Usage

All the method listed below are the same documented on the RESTful API, so this guide won't be covering any params required for each method. Please, yout can however refer to the Examples sections.

Create the client

First you'll need to initialize the client by providing your API. To get an API, visit the documentation and click on "Get a Key" button.

Enter Test Mode

Please consider entering test mode when starting to experiment with this API. Note that under test mode, you have full control over your tasks. You can create, cancel, change your task statues or even delete them. But remember to hack responsibly 😉.

Create a delivery request linked to your main account on Monespace

• Method : $delivery->createTaskForAPIUser($email = string, array $delivery_params = [], array $pickup_params = [])

You can use this method if you also want to track your orders on the Monespace web client application. Note that you must specify the email address of the account that has access to the application. Again, make sure to read the documentation for params expected by this method

• Example :

Create a standard Delivery Request with a pickup

• Method : $delivery->create(array $delivery_params = []);

Make sure to read the documentation before sending any requests.

• Example :

Make a delivery quote request

• Method : $delivery->submitQuotesRequest(array $quotes_params = [])

You can get delivery quotes directly from the API. Usually, the rates are already communicated to you through the contract that you have approved or signed to start using Paps.

• Example :

Read a delivery task's information

• Method : $delivery->get($task_id = string)

You can view a task that has been created using this method.

• Example :

Get a list of delivery

• Method : $delivery->listDeliveries($date = string, $start_date = string, $end_date = string, $select_by = string)

You can view a task that has been created using this method.

• Example :

Cancel a delivery

• Method : $delivery->cancel($task_id = string)

You can cancel a task by providing it's ID. Remember you can't cancel a task that has the following status : IN_PROGRESS and STARTED.

• Example :

WooCommerce Integration

WooCommerce Paps Integration Plugin

License

The MIT License (MIT).