README

这是一个 Laravel 库，用于在肯尼亚和加纳实现 beba API 上的取货和送货服务。该软件包使用 REST API，该 API 在此 链接 上进行了文档说明。这是在沙盒（测试）模式下开发的。要上线，请联系 Anzil Software Ltd，邮箱为 api-feedback@pikieglobal.com。

简介

BebaAPI 是 Anzil Software Ltd 的产品，提供详尽的 API，允许开发人员、物流公司和电子商务商店将取货和送货功能集成到他们的应用程序中。 PikieGlobal 通过实现 bebaAPI，为我们网络中的快递公司和骑手提供了一个可靠的平台，从而能够从几乎任何在线商店或企业通过我们的网络将产品交付给客户。Pikie 意图在非洲各地建立一个合作伙伴网络，以扩大其服务范围，为数百万希望在国内（内陆）运输货物的人提供服务。

配置

在项目根目录下创建一个 .env 文件，并在其中设置客户端密钥、客户端密钥和端点 URL

BEBA_CLIENT_KEY= [客户端密钥]
BEBA_CLIENT_SECRET = [客户端密钥]
BEBA_ENDPOINT_URL = [端点 URL]
BEBA_ENV = [生产或沙盒]

安装

1. 要安装 beba 库，只需运行 composer require anzilsystems/beba-laravel-sdk

2. 打开您的 config/app.php 文件，并将以下内容添加到 providers 和 aliases 数组中。当使用 Laravel 5.5+ 时，软件包将自动注册。对于 Laravel 5.4 及以下版本，请在您的 config/app.php 中包含服务提供者和其别名。

   'providers' => [
       AnzilSystems\Beba\BebaServiceProvider::class,
   ],
   
   'aliases' => [
       'Beba' =>  AnzilSystems\Beba\BebaFacade::class,
   ],

用法

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Beba;

class TestController extends Controller
{
    public function getCouriers(){
        print_r(Beba::getCouriers('KEN','1')); // country_code, service_category
    }

    public function getSpecificCourier(){
        print_r(Beba::getSpecificCourier('1')); // courier_id
    }

     public function getSpecificDriver(){
        print_r(Beba::getSpecificDriver('1')); // driver_id
    }

    public function getRates(){
        //pickup latitude,pickup longitude,delivery latitude, delivery longitude
        print_r(Beba::getRates('-1.2173611','36.9000374','-1.2476927','36.872455'));
    }

    public function getCountries(){
        print_r(Beba::getCountries());
    }

    public function getServices(){

        print_r(Beba::getServices());

    }

    public function getPaymentOptions(){
        //parameter country code
        print_r(Beba::getPaymentOptions('KEN')); //country code

    }

    public function getOrderStatus(){
        //parameter unique id UUID Version 4
        print_r(Beba::getOrderStatus('45684e0b-8c73-41be-a118-fc7ab1c17694'));

    }

    public function getOrderDetail(){
        //parameter unique id UUID Version 4
        print_r(Beba::getOrderDetail('45684e0b-8c73-41be-a118-fc7ab1c17694'));

    }

    public function getNearbyDrivers(){
        //parameters radius (km),current latitude, current longitude
        print_r(Beba::getNearbyDrivers('5','-1.2173611','36.9000374'));

    }

    public function getNearbyCouriers(){
        //parameters radius (km),current latitude, current longitude
        print_r(Beba::getNearbyCouriers('5','-1.2173611','36.9000374'));

    }

    public function cancelShipment(){
        //parameter unique id UUID Version 4
        print_r(Beba::cancelShipment('45684e0b-8c73-41be-a118-fc7ab1c17694'));

    }

    public function createShipment(){
  
      # Parameters 
      $item_detail = [
        [
            'item_name' => 'Fish fried',
            'item_quantity'  => 2,
            'unit_cost'    => '200',
            'unit_weight'    => '', //optional
            'unit_volume'    => '',  //optional


        ],
        [
            'item_name' => 'Beef Stew',
            'item_quantity'  => 2,
            'unit_cost'    => '200',
            'unit_weight'    => '', //optional
            'unit_volume'    => '',  //optional
        ]

    ];
    
    $shipment_data = [

        'unique_id' => '45684e0b-8c73-41be-a118-fc7ab1c17694', //UUID Version 4
        'service_id' => '1',
        'customer_name' => 'Jane Doe',
        'customer_phone' => '254721123456',
        'customer_email' => 'janedoe@gmail.com',
        'pickup_address' => 'Safari Park Fly Over, Thika Road, Nairobi, Kenya',
        'pickup_country' => 'KENYA',
        'pickup_latitude' => '-1.2256562',
        'pickup_longitude' => '36.88495850000004',
        'customer_city' => 'Nairobi, Kenya',
        'business_name' => 'ABC Hotel',
        'business_phone' => '254721174236',
        'business_email' => 'johndoe@gmail.com	',
        'delivery_address' => 'Naivas, Outer Ring Road, Nairobi, Kenya',
        'delivery_country' => 'KENYA',
        'delivery_latitude' => '-1.2476927',
        'delivery_longitude' => '36.872455',
        'business_city' => 'Nairobi , Kenya',
        'courier_id' => '12',
        'driver_id' => '',
        'courier_type' => '1',
        'item_detail' => $item_detail,
        'business_hours' => '8.00 AM - 5.00 PM',
        'order_value'  => '700',
        'shipping_mode'  => '1', //send to one 
        'currency_code'  => 'KES'
            
    ];

    print_r(Beba::createShipment($shipment_data));

    }

参考

[REST API 参考] (https://www.pikieglobal.com/docs)

支持

需要使用此软件包的支持：-

• api-feedback@pikieglobal.com

贡献者

• Basil Ndonga
• Dennis Mayeku

许可

此软件包是开源软件，受 MIT 许可 许可。

编码愉快!!!!!!!

安全

如果您发现任何与安全相关的问题，请通过电子邮件 api-feedback@pikieglobal.com 联系，而不是使用问题跟踪器。