yasserbelhimer / laravel-yalidine-dz-api

v1.0 2021-10-07 15:41 UTC

This package is auto-updated.

Last update: 2024-09-07 22:26:32 UTC


README

一个简单的 Laravel 包,用于使用 Yalidine dz API

安装和使用说明

此包允许您使用 Laravel 消费 Yalidine dz Api。

composer require yasserbelhimer/laravel-yalidine-dz-api

首先,在 Yalidine 网站上生成您的 API 和令牌 https://www.yalidine.com/

在 .env 中设置 API ID 和 API 令牌

YALIDINE_API_ID= your yalidine api id
YALIDINE_API_TOKEN= your yalidine api token

安装后,您可以执行如下操作

要了解有关参数和参数的更多信息,请检查 Yalidine API 文档。

获取您的包裹

要获取所有包裹,将空数组传递给 getParcels([]) 函数。

    $parcels = Yalidine::getParcels([]);

要获取一些特定的包裹,传递一个包含追踪包裹的数组给 getParcels($trackings) 函数。

    $trackings = ['YAL-PAR1','YAL-PAR2'....]; // list of your parcels tracking 
    $parcels = Yalidine::getParcels($trackings);

创建一个或多个新包裹

要创建新包裹,将包裹数组传递给 createParcels($parcels) 函数。

    $parcels = array( // the array that contains all the parcels
        array ( // first parcel
            "order_id"=>"MyFirstOrder",
            "firstname"=>"Brahim",
            "familyname"=>"Mohamed",
            "contact_phone"=>"0123456789,",
            "address"=>"Cité Kaidi",
            "to_commune_name"=>"Bordj El Kiffan",
            "to_wilaya_name"=>"Alger",
            "product_list"=>"Presse à café",
            "price"=>3000,
            "freeshipping"=> true,
            "is_stopdesk"=> false,
            "has_exchange"=> 0,
            "product_to_collect" => null
        ),
        array ( // second parcel
            "order_id" =>"MySecondOrder",
            "firstname"=>"رفيدة",
            "familyname"=>"بن مهيدي",
            "contact_phone"=>"0123456789",
            "address"=>"حي الياسمين",
            "to_commune_name"=>"Ouled Fayet",
            "to_wilaya_name"=>"Alger",
            "product_list"=>"كتب الطبخ",
            "price"=>2400,
            "freeshipping"=>0,
            "is_stopdesk"=>0,
            "has_exchange"=> false,
        ),
        array ( // third parcel
            ...
        ),
        array( // etc
            ...
        )
    );
    $response = Yalidine::createParcels($parcels );

此函数将返回一个对象数组

    {
    "MyFirstOrder": {
        "success": true,
        "order_id": "MyFirstOrder",
        "tracking": "yal-12345A",
        "import_id": 234
    },
    "MySecondOrder": {
        "success": true,
        "order_id": "MySecondOrder",
        "tracking": "yal-67891B",
        "import_id": 234
    }
}

删除一个或多个包裹

要删除包裹,将追踪包裹数组传递给 deleteParcels($trackings) 函数。

    $trackings = ['YAL-PAR1','YAL-PAR2'....]; // list of your parcels tracking 
    $deliveryFees = Yalidine::deleteParcels($trackings);

获取配送费用

    $deliveryFees = Yalidine::getDeliveryFees();