README

Steedy PHP 客户端 API

您可以在此处查看完整的API文档。（目前只有法语）如果您有任何问题，请随时联系我们。

安装

通过Composer

$ composer require steedy/steedy-client-api-php

使用方法

初始化
创建送货报价
验证送货报价
获取送货状态
取消送货

初始化

$client_id = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'; // contact us at api@1steedy.fr to initiate your API access
$client_secret = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$api = new \Steedy\API($client_id, $client_secret);
// to use the sandbox for testing:
// $api = new \Steedy\API($client_id, $client_secret, 'v1-sandbox');
$api->auth();

创建送货报价

在您开始送货之前，您必须为它创建一个报价。

注意：您可以使用最少的参数创建报价，但我们建议您尽可能多地设置信息，以确保送货顺利进行。

$delivery_quote = $api->post('delivery/create', array(
    'origin_name' => 'Thomas Rambaud',
    'origin_tel' => '0600000000',
    'origin_email' => 'thomas@1steedy.fr',
    'origin_address' => 'Rue de Rivoli, 75001 Paris',
    'origin_commentary' => 'iMac 27 to deliver',
    'destinations' => array(
        array(
            'name' => 'Pierre Guerin',
            'address' => '16 avenue Reille, 75014 Paris',
            'tel' => '0600000000',
            'email' => 'pierre@1steedy.fr',
        )
    )
    'delivery_size' => 3
));

有计划取货

有关送货计划的更多信息，请参阅我们的完整文档此处。

$delivery_quote = $api->post('delivery/create', array(
    'origin_name' => 'Thomas Rambaud',
    'origin_tel' => '0600000000',
    'origin_email' => 'thomas@1steedy.fr',
    'origin_address' => 'Rue de Rivoli, 75001 Paris',
    'origin_commentary' => 'iMac 27 to deliver',
    'destinations' => array(
        array(
            'name' => 'Pierre Guerin',
            'address' => '16 avenue Reille, 75014 Paris',
            'tel' => '0600000000',
            'email' => 'pierre@1steedy.fr',
        )
    )
    'delivery_size' => 3,
    'schedule_at' => 1511710610
));

多个投递点

$delivery_quote = $api->post('delivery/create', array(
    'origin_name' => 'Thomas Rambaud',
    'origin_tel' => '0600000000',
    'origin_email' => 'thomas@1steedy.fr',
    'origin_address' => 'Rue de Rivoli, 75001 Paris',
    'origin_commentary' => 'iMac 27 to deliver',
    'destinations' => array(
        array(
            'name' => 'Pierre Guerin',
            'address' => '16 avenue Reille, 75014 Paris',
            'tel' => '0600000000',
            'email' => 'pierre@1steedy.fr',
        ),
        array(
            'name' => 'Réginald Cassius',
            'address' => '14, villa des Coteaux, 93340 Le Raincy',
            'tel' => '0600000000',
            'email' => 'reginald@1steedy.fr',
            'commentary' => 'Door code: XXXX'
        )
    )
    'delivery_size' => 3
));
// print $delivery_quote['quote_id'] ==> 123

验证送货报价

一旦您成功创建了送货报价，您就可以验证它。验证报价将触发其计费过程。

$validate_result = $api->post('delivery/validate', array(
    'quote_id' => $quote_id
));
// print $validate_result['order_id'] ==> 123

获取送货状态

您可以通过查询/delivery/follow端点来检查您的送货状态。

$follow_result = $api->get('delivery/follow', array(
    'order_id' => $order_id
));

取消送货

如果您的送货尚未被steedy接受，您仍然可以取消它并获得退款。将您的送货订单发布到/delivery/cancel以取消您的送货订单。

$cancel_result = $api->post('delivery/cancel', array(
    'order_id' => $order_id
));

检查地址的有效性

有时，检查地址是否有效并由我们的服务处理对于您的应用程序或电子商务网站来说可能很有用。为此，请使用以下方法。

$check_result = $api->post('delivery/is-valid-address', array(
    'address' => '16 avenue Reille, 75014 Paris'
));
$is_valid_address = isset($check_result['is_valid_address']) && $check_result['is_valid_address'] === TRUE;

steedy / steedy-client-api-php

维护者

详细信息