Skip to content

路图对接脚本说明.md

Latest commit

 

History

History
102 lines (82 loc) · 2.97 KB

路图对接脚本说明.md

File metadata and controls

102 lines (82 loc) · 2.97 KB
Raw

路图脚本对接说明

该脚本会做成定时任务的形式，订单同步会有一定的延迟

路图需要提供以下功能/数据

  1. 路图各门店与旅拍门店的对应关系

  2. 订单查询接口: 用于查询路图的新订单, 可以根据日期、门店等过滤

    返回数据也需要对数据进行签名，返回的Header里需要提供以下字段: PG-Timestamp，PG-AccessKey，PG-Sign 订单信息至少需要提供:

    订单ID, 门店ID, 订单图片，底片数量、精修片数, 用户手机号, 订单状态

  3. 回调接口: 用于接收订单状态变更，同步订单状态

对于 "订单查询接口" 和 "回调接口"，需要添加签名验证，具体签名算法请查看对接文档

接口实现参考文档

订单查询接口

接口地址: /api/orders

请求方式: GET

GET请求参数:

参数名 必填 类型 描述
from 是 number 开始时间戳
to 是 number 结束时间戳
status 否 string 订单状态
page 是 number 当前页
pageSize 是 number 分页大小

返回数据

参数名 描述 类型
page 当前页 number
pageSize 分页大小 number
totalPage 总页数 number
orders 订单列表 object[]
orders.id 订单id string
orders.storeId 门店id string
orders.photoRetouchNumber 精修数量 number
orders.photoNumber 底片数量 number
orders.mobile 用户手机号 string[]
orders.status 订单状态 string
orders.images 订单图片 object[]
orders.images.name 图片名 string
orders.images.url 图片URL地址 string

返回数据示例:

{
   "page": 1,
   "pageSize": 20,
   "totalPage": 5,
   "orders": [{
      "id": "",
      "storeId": "",
      "photoRetouchNumber": 0,
      "photoNumber": 0,
      "mobile": ["13911111111"],
      "status": "",
      "images": [{
         "name": "",
         "url": ""
      }]
   }]
}

品果需要完成的功能

  1. 根据路图提供的门店对应关系，初始化旅拍里对应的门店关系

  2. 通过路图的订单查询接口拉取最新的订单并将订单同步到旅拍系统

  3. 订单详情接口

    GET /v1/orders/订单ID

    {
"id": "",
"tradeNo": "",
"outOrderId": "",
"status": "",
"qrCode": "http://xxxx/a/b",
"storeId": ""
}

  4. 订单状态变更回调数据:

    {
"type":"order",
"data": "{\"id\":\"\",\"tradeNo\":\"\",\"outOrderId\":\"\",\"status\":\"\",\"qrCode\":\"http://xxxx/a/b\",\"storeId\":\"\"}"
}