|
|
<?php
namespace App\Service\v3;
use App\Exception\BusinessException;use Hyperf\Guzzle\ClientFactory;use Hyperf\Utils\ApplicationContext;
/** * 顺丰同城相关 * 文档：https://commit-openic.sf-express.com/open/api/docs/index#/apidoc
*/class SfExpress{ private string $dev_id; private string $dev_key; private string $shop_id; private string $host = 'https://openic.sf-express.com'; private ClientFactory $clientFactory; private static ?SfExpress $_instance = NULL;
public function __construct() { $this->dev_id = env('SF_EXPRESS_DEV_ID'); $this->dev_key = env('SF_EXPRESS_DEV_KEY'); $this->shop_id = env('SF_EXPRESS_SHOP_ID'); $this->clientFactory = ApplicationContext::getContainer()->get(ClientFactory::class); }
public static function getInstance(): SfExpress { if (is_null(self::$_instance)) { self::$_instance = new static(); } return self::$_instance; }
/** * 创建订单 */ public function createOrder(array $params): array { if (!isset($params['shop_order_id'], $params['order_time'], $params['receive'], $params['order_detail'])) { throw new BusinessException(500, '商户订单号、用户下单时间、收货信息、订单信息不能为空'); }
$params = array_merge([ 'dev_id' => $this->dev_id, //必填
'shop_id' => $this->shop_id, //必填
'shop_type' => 1, //1:顺丰店铺ID 2:接入方店铺ID
'shop_order_id' => '', //商户订单号
'shop_preparation_time' => 15, //商家预计备餐时长，分钟级时间 比如: 10 分钟 则传入 10
'order_source' => '街链平台', //必填。订单接入来源 1：美团；2：饿了么；3：百度；4：口碑；其他请直接填写中文字符串值
// 'order_sequence' => '', //取货序号 与order_source配合使用 如：饿了么10号单，表示如下：order_source=2;order_sequence=10。用于骑士快速寻找配送物
// 'lbs_type' => 2, //坐标类型，1：百度坐标，2：高德坐标
'pay_type' => 1, //必填，用户支付方式：1、已支付 0、货到付款
'order_time' => time(), 'is_appoint' => 0, //必填，是否是预约单，0：非预约单；1：预约单
'appoint_type' => 0, //预约单类型，1：预约单送达单；2：预约单上门单，默认：0
// 'expect_time' => '', //用户期望送达时间，若传入自此段且时间大于配送时效，则按照预约送达单处理，时间小于配送时效按照立即单处理；appoint_type=1时需必传,秒级时间戳
// 'expect_pickup_time' => '', //用户期望上门时间，appoint_type=2时需必传,秒级时间戳
// 'shop_expect_time' => 0, //商家期望送达时间 只展示给骑士，不参与时效考核；秒级时间戳
'is_insured' => 0, //必填，是否保价，0：非保价；1：保价
'is_person_direct' => 0, //必填，是否是专人直送订单，0：否；1：是
// 'vehicle' => 0, //配送交通工具，0：否；1：电动车；2：小轿车
// 'declared_value' => 0, //保价金额
// 'gratuity_fee' => 0, //订单小费，不传或者传0为不加小费，单位分，加小费最低不能少于100分
'remark' => '无备注', //订单备注
'rider_pick_method' => 1, //物流流向，1：从门店取件送至用户；2：从用户取件送至门店
'return_flag' => 511, //1:商品总价格，2:配送距离，4:物品重量，8:起送时间，16:期望送达时间，32:支付费用，64:实际支持金额，128:优惠券总金额，256:结算方式，例如全部返回为填入511
'push_time' => time(), //必填，推单时间，秒级时间戳(格林尼治时间)
'version' => 17, //版本号 参照文档主版本号填写 如：文档版本号1.7,version=17
'receive' => [ //收货人信息 Obj，详见receive结构
'user_name' => '', //必填，用户姓名
'user_phone' => '', //必填，用户电话
'user_address' => '', //必填，用户详细地址
'user_lng' => 0, //必填，用户地址经度
'user_lat' => 0, //必填，用户地址纬度
// 'city_name' => '', //发单城市 用来校验是否跨城；请填写城市的中文名称，如北京市、深圳市
], /*'shop' => [ //发货店铺信息；obj，详见shop结构，平台级开发者需要传入
'shop_name' => '店铺姓名', 'shop_phone' => '店铺电话', 'shop_address' => '店铺地址', 'shop_lng' => '店铺经度', 'shop_lat' => '店铺纬度', ],*/ 'order_detail' => [ // 必填，订单详情
'total_price' => 0, //用户订单商品总金额（单位：分） 100 表示1元（最大值为100万, 超过此值则按100万计算）
'product_type' => 10, //必填，物品类型。1:快餐，2:药品，3:百货，4:脏衣服收，5:干净衣服派，6:生鲜，其它详见文档
// 'user_money' => 0, // 用户实付商家金额（单位：分） 100 表示1元
// 'shop_money' => 0, // 商家实收用户金额（单位：分） 100 表示1元
'weight_gram' => 0, // 必填，物品重量（单位：克） 100 表示100g
// 'volume_litre' => 0, // 物品体积（单位：升） 1 表示1升
// 'delivery_money' => 0, // 商家收取用户的配送费（单位：分） 100 表示1元
'product_num' => 1, // 必填，物品个数
'product_type_num' => 1, // 必填，物品种类个数
'product_detail' => [ // 必填，物品种类个数
[ 'product_name' => '', // 必填，物品名称
// 'product_id' => 1, // 物品ID
'product_num' => 1, // 必填，物品数量
// 'product_price' => 0, // 物品价格
// 'product_unit' => 0, // 物品单位
// 'product_remark' => 0, // 备注
// 'item_detail' => 0, // 详情
], ], ], /*'multi_pickup_info' => [ //多点取货信息
[ 'pickup_shop_address' => '取货点地址', // 必填，取货点地址
'pickup_shop_phone' => '取货点店铺手机号', // 必填，取货点店铺手机号
'pickup_shop_name' => '取货点店铺手机号', // 必填，取货点店铺名称
'pickup_lng' => '取货点经度', // 必填，取货点经度
'pickup_lat' => '取货点纬度', // 必填，取货点纬度
'pickup_products' => '', // 必填，取货点店铺物品信息
], ],*/ ], $params);
return $this->send('/open/api/external/createorder', $params); }
/** * 取消订单 */ public function cancelOrder(array $params): array { $params = array_merge([ 'dev_id' => $this->dev_id, 'order_id' => $params['order_id'], 'shop_id' => $this->shop_id, // 使用商家订单号，需要传入shop_id
'shop_type' => 1, // 输入shop_id，shop_type需必传
'order_type' => 2, // 订单ID类型，1、顺丰订单号 2、商家订单号
'cancel_code' => 300, 'push_time' => time(), ], $params);
return $this->send('/open/api/external/cancelorder', $params); }
/** * 获取顺丰同城配送费 */ public function getDeliveryCost(array $params): float { $res = $this->preCreateOrder($params); $real_pay_money = $res['result']['real_pay_money'] ?? null; if ($real_pay_money === null) { throw new BusinessException(500, '获取配送费失败'); } return (float)bcdiv($real_pay_money, 100, 2); }
/** * 获取原始配送费 */ public function getOriginDeliveryCost(float $deliveryCost): float { return (float)bcadd($deliveryCost,3.50,2); }
/** * 预创建订单 */ private function preCreateOrder(array $params): array { if (!isset($params['user_lng'], $params['user_lat'], $params['user_address'], $params['weight'], $params['shop'])) { throw new BusinessException(500, '经度、纬度、收货地址、重量、发货店铺信息不能为空'); } $params = array_merge([ 'dev_id' => $this->dev_id, //必填
'shop_id' => $this->shop_id, //必填
'shop_type' => 1, //1:顺丰店铺ID 2:接入方店铺ID
'user_lng' => 0, //必填，用户地址经度
'user_lat' => 0, //必填，用户地址纬度
'user_address' => '', //必填，用户详细地址
'weight' => 0, //必填，物品重量（单位：克）
'product_type' => 6, //必填，物品类型。1:快餐，2:药品，3:百货，4:脏衣服收，5:干净衣服派，6:生鲜，其它详见文档
// 'total_price' => 0, //用户订单总金额（单位：分）
'is_appoint' => 0, //必填，是否是预约单，0：非预约单；1：预约单
'appoint_type' => 0, //预约单类型，1：预约单送达单；2：预约单上门单，默认：0
// 'expect_time' => '', //用户期望送达时间，若传入自此段且时间大于配送时效，则按照预约送达单处理，时间小于配送时效按照立即单处理；appoint_type=1时需必传,秒级时间戳
// 'expect_pickup_time' => '', //用户期望上门时间，appoint_type=2时需必传,秒级时间戳
// 'lbs_type' => 2, //坐标类型，1：百度坐标，2：高德坐标
'pay_type' => 1, //必填，用户支付方式：1、已支付 0、货到付款
// 'receive_user_money' => 0, //代收金额，单位：分
'is_insured' => 0, //必填，是否保价，0：非保价；1：保价
'is_person_direct' => 0, //必填，是否是专人直送订单，0：否；1：是
// 'declared_value' => 0, //保价金额
// 'gratuity_fee' => 0, //订单小费，不传或者传0为不加小费，单位分，加小费最低不能少于100分
'rider_pick_method' => 1, //物流流向，1：从门店取件送至用户；2：从用户取件送至门店
'return_flag' => 511, //1:商品总价格，2:配送距离，4:物品重量，8:起送时间，16:期望送达时间，32:支付费用，64:实际支持金额，128:优惠券总金额，256:结算方式，例如全部返回为填入511
'push_time' => time(), //必填，推单时间，秒级时间戳(格林尼治时间)
/*'shop' => [ //发货店铺信息；obj，详见shop结构，平台级开发者需要传入
'shop_name' => '店铺姓名', 'shop_phone' => '店铺电话', 'shop_address' => '店铺地址', 'shop_lng' => '店铺经度', 'shop_lat' => '店铺纬度', ], 'multi_pickup_info' => [ //多点取货信息
'pickup_shop_address' => '取货点地址', 'pickup_lng' => '取货点经度', 'pickup_lat' => '取货点纬度', ],*/ ], $params);
return $this->send('/open/api/external/precreateorder', $params); }
/** * 发送请求 */ public function send(string $url, array $params): array { $url = $this->host . $url; $url = $url . (str_contains($url, '?') ? '&sign=' . $this->getSign($params) : '?sign=' . $this->getSign($params));
$res = json_decode($this->clientFactory->create()->post($url, ['json' => $params])->getBody()->getContents(), true); if (!$res || !isset($res['error_code']) || $res['error_code'] != 0) { throw new BusinessException(500, ($res['error_code'] ?? '') . ':' . ($res['error_msg'] ?? '请求异常')); }
return $res; }
/** * 计算请求签名 */ private function getSign(array $params): string { $post_data = json_encode($params); $sign_char = $post_data . "&{$this->dev_id}&{$this->dev_key}"; return base64_encode(md5($sign_char)); }
/** * 前端传上来的送达时间（如：11:30 - 12:00）转顺丰的expect_time等预约参数 */ public function deliveryTimeNote2expectTime(string $deliveryTimeNote): array { if (!empty($deliveryTimeNote) && $deliveryTimeNote != '尽快送达' && strpos($deliveryTimeNote, '-') !== false) { $arr = array_map(function ($v) { return trim($v); }, explode('-', $deliveryTimeNote));
if ($arr[0] && $arr[1]) { $startTime = strtotime($arr[0]); $endTime = strtotime($arr[1]); # 判断是否是有效时间戳
if ($startTime > 1650000000 && $endTime > 1650000000) { $sfParams['is_appoint'] = 1; $sfParams['appoint_type'] = 1; $sfParams['expect_time'] = floor(($startTime + $endTime) / 2); } } } return $sfParams ?? []; }}
|
