README

一个用于消耗Paps API的PHP客户端。

此客户端针对API版本v2.

安装

通过Composer

$ composer require paps-app/paps-php-client

所需的最小PHP版本是5.6

用法

以下列出所有方法都与RESTful API上的文档相同，因此本指南不会涵盖每个方法所需的任何参数。但是，您仍然可以参考示例部分。

创建客户端

首先，您需要通过提供API来初始化客户端。要获取API，请访问文档并点击“获取密钥”按钮。

$client = new Paps\PapsClient([
  'api_key' => '<Your API Key>'
]);

进入测试模式

请在开始使用此API进行实验时考虑进入测试模式。请注意，在测试模式下，您可以对您的任务拥有完全控制权。您可以创建、取消、更改任务状态，甚至删除它们。但请记住要负责任地操作。

$client = new Paps\PapsClient([
  'api_key' => '<Your API Key>',
  'mode' => 'test'
]);

在Monespace上创建与您的主账户关联的配送请求

方法： $delivery->createTaskForAPIUser($email = string, array $delivery_params = [], array $pickup_params = [])

如果您还希望在Monespace网络客户端应用程序中跟踪您的订单，则可以使用此方法。请注意，您必须指定具有应用程序访问权限的账户的电子邮件地址。同样，请确保阅读此方法预期的参数文档。

示例

$delivery = new Paps\Resources\Delivery($client);

// Email registered on your Monespace account
$email = "kiamet@example.com"

// Prepare your pickups params
$pickups = [
    [
        "address" => "Almadies, Dakar, Senegal",
        "name" => "Saliou Samb",
        "time" => date('Y-m-d H:i:s', time()),
        "phone" => "+221700000000",
        "job_description" => "Test Saliou"
    ]
];

// Prepare your delivery params
$deliveries = [
    [
        "address" => "Medina, Dakar, Senegal",
        "name" => "Modou Diakahté",
        "time" => date('Y-m-d H:i:s', time()),
        "phone" => "+221700000000",
        "job_description" => "Test Saliou"
    ]
];

// Pass your request
$response = $delivery->createTaskForAPIUser($email, $pickups, $deliveries);

// Read your response, hopefully successful.
echo json_encode($response);

创建一个带有取货的标准配送请求

方法： $delivery->create(array $delivery_params = []);

在发送任何请求之前，请务必阅读文档。

示例

$delivery = new Paps\Resources\Delivery($client);

// Prepare your params
$delivery_params = [
  'jobDescription' => 'Commande venant du site de Test',
  'jobPickupPhone' => '778888888',
  'jobPickupName' => 'Test Pickup Name',
  'jobPickupAddress' => 'Medina, Dakar, Sénégal',
  'jobPickupDatetime' => '2019-01-12 12:00:00',
  'jobDeliveryDatetime' => '2019-01-14 12:00:00',
  'customerUsername' => 'Test Delivery Name',
  'customerAddress' => 'Urbam, Dakar, Sénégal',
  'customerPhone' => '779999999'
];

// Pass your request
$response = $delivery->create($delivery_params);

// Read your response, hopefully successful.
echo json_encode($response);

进行配送报价请求

方法： $delivery->submitQuotesRequest(array $quotes_params = [])

您可以直接从API获取配送报价。通常，费用已经通过您批准或签署的合同传达给您，以开始使用Paps。

示例

$delivery = new Paps\Resources\Delivery($client);

// Prepare your request params
$quotes_params = [
  "origin" => "Medina, Dakar, Senegal",
  "destination" => "Almadies, Dakar, Senegal",
  "packageSize" => "small"
];

// Pass your request
$response = $delivery->submitQuotesRequest($quotes_params);

// Read your response, hopefully successful.
echo json_encode($response);

读取配送任务的详细信息

方法： $delivery->get($task_id = string)

您可以使用此方法查看已创建的任务。

示例

$delivery = new Paps\Resources\Delivery($client);

// Prepare your request params
$task_id = "7233112";

// Pass your request
$response = $delivery->get($task_id);

// Read your response, hopefully successful.
echo json_encode($response);

获取配送列表

方法： $delivery->listDeliveries($date = string, $start_date = string, $end_date = string, $select_by = string)

您可以使用此方法查看已创建的任务。

示例

$delivery = new Paps\Resources\Delivery($client);

// Prepare your request params
$start_date = date('Y-m-d H:i:s'),
$end_date = date('Y-m-d H:i:s'),
$select_by = "intervalle"

// Pass your request
$response = $delivery->listDeliveries(null, $start_date, $end_date, $select_by);

// Read your response, hopefully successful.
echo json_encode($response);

取消配送

方法： $delivery->cancel($task_id = string)

您可以通过提供其ID来取消任务。请记住，您不能取消以下状态的任务：IN_PROGRESS和STARTED。

示例

$delivery = new Paps\Resources\Delivery($client);

// Prepare your request params
$task_id = "7233112";

// Pass your request
$response = $delivery->cancel($task_id);

// Read your response, hopefully successful.
echo json_encode($response);

WooCommerce集成

WooCommerce Paps集成插件

许可证

MIT许可证 (MIT)。

paps-app / paps-php-client

维护者

详细信息