点我达骑手接口文档

5.7.4版本(v72)

1.submit-device-info.json(新增)

• 接口说明：提交设备信息接口
• 接口地址：rider/base/submit-device-info.json
• 请求参数：

{
  "cityId":1,
  "riderId":"10010",
  "os": "Android|iOS",//系统
  "idfa": "",//idfa
  "idfv": "",//idfv
  "imei": "",//imei
  "deviceModel": "",//手机型号
  "cpuModel": "",//CPU型号
  "cpuCoreCount": "",//CPU核心数
  "RAM": "",//运行总量
  "ROM": "",//内存总量
  "batteryCapacity": "",//电池容量
  "resolution": "",//手机分辨率
  "screen": "",//屏幕尺寸
  "cameraPixel": "",//摄像头像素
  "ipAddress": "",//IP地址
  "deviceBrand": "",//手机厂商
  "network": ""//移动网络信息
}

• 响应报文

{
    status:1,
    data:{
        successText:""
    }
}

2.rider-hot-areas.json

• 接口说明：获取热力图数据
• 接口地址：rider/base/rider-hot-areas.json
• 请求参数

{
    cityId:String,
    riderId:String,
    ltLat:int,
    ltLng:int,
    rtLat:int,
    rtLng:int,
    lbLat:int,
    lbLng:int,
    rbLat:int,
    rbLng:int,
    lat:int,
    lng:int,
    type:int //类型：0-当前热力分布  1-预测热力分布
}

• 响应报文

{
    status:1,
    data:{
        warning:[],
        areas:[]
    },
    msg:""
}

3.view-hema-goods-list.json

• 接口说明：盒马货品详情
• 接口地址：rider/order-query/view-hema-goods-list.json
• 请求参数

{
    cityId:String,
    riderId:String,
    orderId:String,
    source:int,
    orderType:int
}

• 响应报文

{
    status:1,
    data:{
        totalGoodsNumber:String //类型：当前订单总的商品数量
        goodsList:[
                {'pickingNumber':String //类型：当前实际拣货数量
                }  ],
    },
    msg:""
}

4.thief-operation.json

• 接口说明：外挂
• 接口地址：rider/base/thief-operation.json
• 请求参数

{
    cityId:String,
    riderId:String,
    operateType:int,//操作类型，1-禁用操作，2-解禁
    thiefList:[{
     "packageName":String //包名
     "code":String,//外挂ID
     "actionType":int,//风控行为
    }
    ]
}

• 响应报文

{
    status:1,
    data:{
        successText:""
    },
    msg:"",
    code:10001  //重新拉取配置规则
}

4.upload-position.json

• 接口说明：轮询
• 接口地址：rider/polling/upload-position.json
• 请求参数

{
    cityId:String,
    riderId:String,
    imei:String,
    lat:int,
    lng:int,
    version:String,
    locationType:int,
    client:String
    jumpPoint:int,
    utc:long
}

• 响应报文

{
    "status": 1,
    "data": {
        "updateType": 0,
        "url": "",
        "latestVersion": "",
        "tips": "",
        "md5": "",
        "isSelf": 1,
        "verifyResult": "",
        "notSelfText": "",
        "orderNotifyList": [],
        "lostConnectionNotify": "",
        "riderTypeChangeNotify": "",
        "notificationNotify": 0,
        "cancelOrderPunishNotify": "",
        "orderCellingChangedNotify": "",
        "verifiedOvertime": false,
        "patchUpdateNotify": 0,
        "forbiddenNotify": "",
        "upgradeProtocolNotify": "",
        "robOrderNotify": 0,
        "serviceTimeStamp": 1551063922716,
        "bannerNotify": 1,
        "bundleId": "",
        "authResult": "",
        "agingStatus": 0,
        "zcOrderStatus": 0,
        "weexConfigVersion": "",
        "weexConfigUrl": "",
        "weexConfigMD5": "",
        "recommendOrderNotify": 0,
        "httpdnsSwitch": 0,
        "dialogNotify": {
            "imgUrl": "",
            "forwardUrl": "",
            "checkId": "",
            "type": "",
            "deadline": "",
            "tips": "",
            "deadlineTs": ""
        },
        "residentNotify": {
            "shopName": "",
            "residentTaskId": ""
        },
        "driftOpen": 0,
        "wsOpen": 1,
        "hemaDispatch": 0,
        "hemaChecked": 0,
        "hySdkOpen": 0,
        "modifyPhoneSuccess": "",
        "sopNotify": [],
        "weatherType": 0,
        "newProduct": "",
        "riderLevelInfo": "",
        checkBanners:[
            {
                checkId:String,//抽查ID
                deadline:long,//抽查截止时间戳，long类型，毫秒为毫秒
                type:String//抽查类型,枚举值与dialogNotify保持一致
            }
        ]
    },
    "msg": "",
    "errorCode": "",
    "extraMsg": ""
}

5.7.6版本(v73)

1.get-banner-info.json(修改)

• 接口说明：获取banner广告信息
• 接口地址：rider/notify/get-banner-info.json
• 请求参数：

{
  "cityId":1,
  "riderId":"10010",
  "locationPage": "位置标志(1-推荐单列表)  2-我的钱包"
}

• 响应报文

{
    status:1,
    data:{
        "locationId":"" 位置标志ID 类型：int
        "bannerList":[
            {
            "bannerId":标志ID 类型 int
            "imageUrl":图片url  类型 String
            "url":跳转url 类型 String
            "adMobile":是否是AdMobile广告 0-否 1-是
            isAd:int,//是否是广告图片  0-不是  1-是 
            }
        ] banner列表
    }
}

2.login.json(修改)

• 接口说明：获取banner广告信息
• 接口地址：rider/base/login.json
• 请求参数：

{
    "cityId":1,
    "riderId":"10010",
    captcha:String,
    lat:int,
    lng:int,
    version:String,
    imei:String,
    source:String,
    client:String,
    channelId:String,
    phoneVersion:String,
    clientId:String,
    systemCode:flash
}

• 响应报文

{
    "status": 1,
    "data": {
        "updateType": 0,
        "url": "",
        "latestVersion": "",
        "tips": "",
        "md5": "",
        "adPicUrl": "",
        "serverTime": 1552010892404,
        "isNewComer": 0,
        "weexConfigVersion": "",
        "weexConfigUrl": "",
        "weexConfigMD5": "",
        "riderId": 111098,
        "riderType": 0,
        "insuranceFee": 2.33,
        "areaCode": "0571",
        "guideVersion": "",
        "tradingAreaId": "",
        "riderName": "点小哥",
        "identityCard": "41142519900316093X",
        "forceReadNotify": {
            "id": "",
            "title": "",
            "type": "0",
            "url": "",
            "imageUrl": ""
        },
        "token": "8ea00c17-ea62-48a4-8007-7f82e3f42f95",
        "serverAddress": "",
        "distanceThreshold": 3000.0,
        "targetRadius": 1000.0,
        "distanceTimeInterval": 600,
        "waitForDistanceThreshold": 500.0,
        "newUserReward": true,
        "spreadRedPoint": false,
        "csTel": "0571-88223300",
        "firstLogin": false,
        "registCityId": 1,
        "redPacketVisible": 0,
        "needProtocal": 0,
        "originCityId": "1",
        "adPicInfo": {
            adType:int,//0-自主配置广告   1-admobile广告
            isAd:int,//是否是广告图片  0-不是  1-是
            adPicUrl:String,//广告图片url
            adPicJumpUrl:String,//点击广告图片跳转的url，
            adId:int,//广告图片ID
        }
    },
    "msg": "",
    "errorCode": "",
    "extraMsg": ""
}

3.set-working-area.json(修改)

• 接口说明：设置接单区域
• 接口地址：rider/base/set-working-area.json
• 请求参数：

{
    riderId:String,
    cityId:String,
    workingAreaLat:int,//接单区域中心店纬度，
    workingAreaLng:int,//接单区域中心点经度
    radius:double ,//接单半径
    cityName:String，//城市名称
    lat:int,//骑手当前位置纬度
    lng:int,//骑手当前位置经度
}

• 响应报文

{
    status:1,
    data:{
        successText：String
    },
    errorCode:9602-设置接单区域超出距离，并在errorMsg中返回超距文案
    extraMsg:String errorCode=9602时返回超距时的配置的距离，如“500”，单位为米
}

4.identity-face-detection.json(修改)

• 接口说明：设置接单区域
• 接口地址：rider/base/identity-face-detection.json
• 请求参数：

{
    cityId:String,
    riderId:String,
    name:String,
    identityNumber:String,
    faceImage:String
}

• 响应报文

{
    status:1,
    data:{
        successText：String
    },
    errorCode:9700-降级到人工认证流程
}

{
    cityId:String,
    riderId:String,
    lat:int
    lng:int
}

- 响应报文

{
    status:1,
    data:{
        //位置信息 状态 0正常 99-单项超时 其他不正常 
        "locationStatus":0,
        "locationText":"", 类型String
        //工作状态 工作中（0）未开启工作状态（-1）
        "workStatus":0, 
        "workText":"", 类型String
        //驻店任务  骑手在驻店任务中（-1）；骑手有绑定的定向服务商家（-2）
        "taskStatus":0,
        "taskText":"", 类型String
        //附近单量 获取正常（0）获取异常（-1）
        "regionStatus": 0,
        "regionText": "",类型String
        //标准帮送 已拥有未开启（-1）未拥有（-2）已开启（0）
        "modelStatus": 0,
        "modelText": "",类型String
        //接单上限  诊断通过（0）诊断不通过（-1）
        "limitStatus": 0,
        "limitText": "",类型String
        //订单互斥 无互斥单（0）有互斥单（-1）
        "orderStatus":0,
        "orderText":"",类型String
        //骑手等级 诊断通过（0）诊断不通过（-1）
        "levelStatus": 0,
        "levelText": "",类型String
        //风险应用 不存在风险（0）风险管控中（-1）
        "riskStatus":0,
        "riskText":"", 类型String

        "jumpCapacityId": 1, 类型：int 跳转的标品ID

        //此次检测ID
        "diagnoseReportId": 13056, 类型int
        //已接订单数量 30 
        "receivedOrderNum": "30", 类型String
        //取消订单数量 30
        "cancelOrderNum": "0", 类型String
        //接单能力描述 html格式 
        "receivedOrderEvaluate": "", 类型String HTML格式 
        //取消单量能力描述
        "cancelOrderEvaluate": "", 类型String
    },
}

6.get-deposit-list.json(修改)

• 接口说明：保证金明细
• 接口地址：rider/trade/get-deposit-list.json
• 请求参数：

{
    cityId:String,
    riderId:String,
    currentPage:int,
}

• 响应报文

{
    status:1,
    data:{
        "currentPage":int
        "pageCount":int
        "list":[{
            "title":String
            "desc":String
            "time":String  
            "amountStr":String
            "colorType":int
            effectiveAmount:String 有效保证金

        }]
    },
}

7.rob-order-list.json(修改)

• 接口说明：抢单列表
• 接口地址：rider/order-query/rob-order-list.json
• 请求参数：

{
    cityId:String,
    riderId:String,
    keyword:String,
    lat:int,
    lng:int,
    sortType:int//排序类型 0-智能排序  1-距离由近到远  2-顺路度由高到低   3-价格由高到低
}

• 响应报文

{
    "status": 1,
    "data": {
        "tips": "当前无标准帮送订单，试试其他接单模式",
        "btnText": "",
        "currentPage": 1,
        "pageCount": 1,
        "riderStatus": 0,
        "verifiedStatus": 10,
        "groupList": [],
        "isHealthCertificateUploaded": 0,
        "healthCertificationText": "",
        "forbiddenText": "",
        "buttonText": "开始工作",
        "buttonType": 6,
        "trainStatus": 0,
        "newChannelNum": 0,
        "isScanCode": true
    },
    "msg": "",
    "errorCode": "",
    "extraMsg": ""
}

{
    cityId:String,
    riderId:String
}

- 响应报文

{
    status:1,
    data:{
        "forbidden": 类型 int 1-禁用 0-非禁用
        "forbiddenType": 禁用类型 int
    },
}

{
    cityId:String,
    riderId:String,
    forbiddenType:int
}

- 响应报文

{
    status:1,
    data:{
        "successText": 类型 String
    },
}

5.7.8版本(v74)

1.submit-authentication-info.json(修改)

• 接口说明：提交认证信息
• 接口地址：/rider/base/submit-authentication-info.json
• 请求参数：

{
    "cityId":1,
    "riderId":"10010",
    lat:int,
    lng:int,
    realName:String,
    identityCard:String,
    type:int,
    params:String
    frontImage:String,//身份证正面照URL
    backImage:String,//身份证背面照URL
    holdImage:String，手持身份证照URL
}

• 响应报文

{
    status:1,
    data:{
        successText:""
    }
}

2.login.json(修改)

• 接口说明：登录
• 接口地址：rider/base/login.json
• 请求参数：

{
    "cityId":1,
    "riderId":"10010",
    captcha:String,
    lat:int,
    lng:int,
    version:String,
    imei:String,
    source:String,
    client:String,
    channelId:String,
    phoneVersion:String,
    clientId:String,
    systemCode:flash
}

• 响应报文

{
    "status": 1,
    "data": {
        "updateType": 0,
        "url": "",
        "latestVersion": "",
        "tips": "",
        "md5": "",
        "adPicUrl": "",
        "serverTime": 1552010892404,
        "isNewComer": 0,
        "weexConfigVersion": "",
        "weexConfigUrl": "",
        "weexConfigMD5": "",
        "riderId": 111098,
        "riderType": 0,
        "insuranceFee": 2.33,
        "areaCode": "0571",
        "guideVersion": "",
        "tradingAreaId": "",
        "riderName": "点小哥",
        "identityCard": "41142519900316093X",
        "forceReadNotify": {
            "id": "",
            "title": "",
            "type": "0",
            "url": "",
            "imageUrl": ""
        },
        "token": "8ea00c17-ea62-48a4-8007-7f82e3f42f95",
        "serverAddress": "",
        "distanceThreshold": 3000.0,
        "targetRadius": 1000.0,
        "distanceTimeInterval": 600,
        "waitForDistanceThreshold": 500.0,
        "newUserReward": true,
        "spreadRedPoint": false,
        "csTel": "0571-88223300",
        "firstLogin": false,
        "registCityId": 1,
        "redPacketVisible": 0,
        "needProtocal": 0,
        "originCityId": "1",
        "adPicInfo": {
            adType:int,//0-自主配置广告   1-admobile广告
            isAd:int,//是否是广告图片  0-不是  1-是
            adPicUrl:String,//广告图片url
            adPicJumpUrl:String,//点击广告图片跳转的url，
            adId:int,//广告图片ID
        }
        homPageType：int,主页类型  0-订单列表主页  1-加入点我达主页
    },
    "msg": "",
    "errorCode": "",
    "extraMsg": ""
}

3.come-to-work.json(修改)

• 接口说明：开始工作
• 接口地址：/rider/base/come-to-work.json
• 请求参数：

{
    "cityId":1,
    "riderId":"10010",
    lat:int,
    lng:int,
    cityName:String,
    workingAreaLat:int,
    workingAreaLng:int,
    radius:float
}

• 响应报文

{
    status:1,
    data:{
        successText:""
    },
    errorCode:
        10003:弹窗引导获取标品资格
        10002:浮层引导打开标品资格
}

4.get-receiving-qualification.json(新增)

• 接口说明：获取接单资格
• 接口地址：/rider/base/get-receiving-qualification.json
• 请求参数：

{
    cityId:int,
    riderId:int
}

• 响应报文

{
    status:1,
    data:{
        list:[
            {
                qualificationId:String,//接单资格ID
                name:String,//接单资格名称
                open:int，//接单资格是否是开启状态 0-关闭  1-开启
            }
            ...
        ]
    },
}

5. get-guide-info.json(新增)

• 接口说明：获取引导信息
• 接口地址：/rider/base/get-guide-info.json
• 请求参数：

{
    cityId:int,
    riderId:int
}

• 响应报文

{
    status:1,
    data:{
        "hasCapacity":1 //是否拥有标品 1-有 0-没有
        "hasOpen":1 ,//是否开通点我达 1-开通 0-没有开通  Number
        "authenticationStatus": 9, //认证状态 0:未认证 5:审核中 9:未通过 10：已认证  Number
        "obtainCapacityInfo":{ //获取的标品能力信息
            "capacityId": 1,//标品ID  Number
            "capacityName":"外卖/商超" ,//标品名称   String
            "finishProgress":80,  Number // 完成进度
        },
        "bannerList":[
            {
                "imageUrl":"" ,//图片url    String
                "advantageIntro":"",//优势介绍   String
                "advantageDesc":"",//优势详细描述   String
            },
        ],
        "reZhaoRider":[ //热招骑手
            {
                "capacityId": 1,//标品ID  Number
                "hotInvite":1, //是否热招 1-是 0-不是
                "wantName":"" , //招聘rider名称   String
                "advantageList":[
                    "单价高","赚钱超多" 
                ],
                "imageUrl":"",//配图地址   String
            }
        ],
        "commonQuestion":[ //常见问题
            {
                "question":"", String
                "answer":""  String
            }
        ]
    },
}

6. get-want-rider-type.json(新增)

• 接口说明：获取招聘的骑手类型
• 接口地址：/rider/base/get-want-rider-type.json
• 请求参数：

{
    cityId:int,
    riderId:int
}

• 响应报文

{
    status:1,
    data:{
        "hasOpen":1 ,//是否开通点我达 1-开通 0-没有开通
        "wantRiderList":[
            {
                "capacityId": 1,//标品ID  Number
                "hotInvite":1, //是否热招 1-是 0-不是
                "wantName":"" ,//招聘rider名称
                "advantageList":[
                    "单价高","赚钱超多"
                ],
                "imageUrl":"",//配图地址
                "finishProgress":40,//完成进度 Number
                "ridrIcon":"",//骑手头像
                "riderName":"",//骑手名
                "riderEvaluate":""//骑手评价
            }
        ],
    },
}

8. get-order-settings.json(修改)

• 接口说明：获取接单设置
• 接口地址：/rider/base/get-order-settings.json
• 请求参数：

{
    cityId:int,
    riderId:int
}

• 响应报文

{
    status:1,
    data:{
        "dispatchAfterLeave": false,
        "orderPattern": "",
        "orderCelling": 5,
        "bannerInfo": "",
        "hasQualification": 1, // 是否有更多的骑手资格(Add),
        "cityCapacity": true, // 该城市下是否有标品(Add),
        "cityName": "城市名", // 该城市名称(Add)
        "capacityList":[
            {
                "name": "普通帮送",
                "icon": "http://testdwbbucket.oss-cn-hangzhou.aliyuncs.com/newhawkeye/template/1537846889135-%E6%99%AE%E9%80%9A%E5%B8%AE%E9%80%81-%E9%AB%98%E4%BA%AE.png",
                "describe": "可送饿了么，商家跑腿；学额外课程可送手淘、天猫、菜鸟驿站",
                "status": 2,
                "statusText": "已开启接单资格", // 文案修改,三种，见交互图(Edit)
                "upgradeText": "升级为标准帮送，可获得更多订单", // 有可升级的标品时返回(Add)
                "upgradeId": "xxx", // 有可升级的标品时返回可升级的标品id(Add)
                "id": "1",
                "describeUrl": "http://www.baidu.com/",
                "sort": 1,
                "sort2": 1,
                "modalMsg": "" // 同接口get-distribution-condition中的modalMsg(Add)
            }
        ],
        "showOrderPattern": 0
    },
    "msg": "",
    "errorCode": "",
    "extraMsg": ""
}

9. get-distribution-condition.json(修改)

• 接口说明：获取接单设置详情
• 接口地址：/rider/base/get-distribution-condition.json
• 请求参数：

{
    cityId:int,
    riderId:int,
    capacityId: int
}

• 响应报文

{
    "status": 1,
    "data": {
        "name": "定制帮送",
        "describe": "完成系列培训课程，可配送盒马、每日优鲜、天虹超市",
        "status": 1,
        "finishProgress": "80", // 进度条百分比(整数)(Add)
        "statusText": "已开启接单资格", // 文案修改，6种，见交互图(Edit)
        "bgColor": "#545435", // 标品对应的背景色(Add)
        "upgradeName": "标准帮送", // 升级标品对应的名称(Add)
        "upgradeId": "3", // 升级标品对应的Id(Add)
        "bgIcon": "http://xxx", // 标品对应的背景图标(Add)
        "features": ["来描述一下它，这里有一段段描述"],// 标品对应的特色数组(Add)
        "capacityRequireList": [{
            "title": "能力要求",
            "statusText": "",
            "statusColor": "",
            "requireList": [{// 将capacityRequireList的statusText往下传递到该list中，且文案有变更！(Edit)
                "name": "驾驶证",
                "status": 4,
                "statusText": "已认证",
                "statusColor": "#909090",
                "operationType": 5, // 新增8: 身份未认证，跳转身份认证页。9:身份认证失败，跳转重新认证页(Edit)
                "operationUrl": "riderCenter/DrivingReviewFailView.js",
                "equipmentList": []
            }]
        }],
        "describeUrl": "",
        "modalMsg": "",
        "isOrderCeiling": 0,
        "orderCeiling": 5
    },
    "msg": "",
    "errorCode": "",
    "extraMsg": ""
}

10. set-distribution-condition-switch.json(修改)

• 接口说明：设置该标品是否开启
• 接口地址：/rider/base/set-distribution-condition-switch.json
• 请求参数：

{
    cityId:int,
    riderId:int,
    capacityId: int,
    setSwitch: 2
}

• 响应报文

{
    "status": 1,
    "data": {
        "status": 1,
        "successText": "已关闭接单模式",
        "statusText": "未开启接单模式" // 同get-order-settings.json接口中的statusText，文案进行了更改(Edit)
    },
    "msg": "",// 1.当前城市暂无法配送此类订单 2.最多同时开启N个接单资格 3.开启失败请重试(Edit)
    "errorCode": "",
    "extraMsg": ""
}

5.8.0版本（v75）

1. get-unread-notify-num.json(修改)

• 接口说明：获取未读消息
• 接口地址：/rider/notify/get-unread-notify-num.json
• 请求参数：

{
    cityId:int,
    riderId:int,
}

• 响应报文

{
    "status": 1,
    "data": {
        "num": 1,
        "newChannelNum": 1,
        "anewAnnouncementUrl": "url" //公告详情页URL
        "amoreAnnouncementCount": 0 //公告个数
    },": "url" //公告详情页URL
    },
    "errorCode": "",
    "extraMsg": ""
}

2. get-important-notify.json(新增)

• 接口说明：获取重要公告列表
• 接口地址：rider/notify/get-important-notify.json
• 请求参数：

{
    status:int, // 0-未读，1-全部
    currentPage:int, // 0-不分页，其余数字分页
    lastNotifyId:int // 上一条消息记录ID
}

• 响应报文

{
    status:1,
    data:{
        "totalCount":1 ,//总数
        "pageCount":1, //总页数
        "currentPage":1, // 当前页码
        "unreadTotalCount" // 未读公告总数
        "list":[
            {
                "id": 1, // id
                "title": '',//标题
                "timeText":'', //格式化的时间
                "isRead":0, // 是否已读，0-未读，1-已读
                "urlType":"" ,//跳转的类别
                "url":'',// 跳转链接
            }
        ],
    },
}

3. get-message-type.json(新增)

• 接口说明：获取消息分类
• 接口地址：rider/notify/get-message-type.json
• 请求参数：

{
    riderId:int
}

• 响应报文

{
    status:1,
    data:{
        "list":[
            {
                "name": '',//类别名称
                "categoryId":'', //类别ID
                "UnreadTotalCount": 0, // 分类下未读的消息数量
            }
        ],
    },
}

4. get-message-list.json(新增)

• 接口说明：获取消息列表
• 接口地址：rider/notify/get-message-list.json
• 请求参数：

{
    status:int, // 0-未读，1-全部
    categoryId:int, // 分类id
    currentPage:int,
    lastNotifyId:int // 上一条消息记录ID
}

• 响应报文

{
    status:1,
    data:{
        "list":[
            {
                "id":1, // id
                "isRead":0, // 是否已读，0-未读，1-已读
                "typeImage":'', //一级分类图标
                "typeName":'', //二级分类名称
                "title": '', // 标题
                "timeText": '', // 格式化时间
                "urlType":"", //跳转的类别
                "url":'', // 跳转链接
            }
        ],
    },
}

5. already-read-msg.json(新增)

• 接口说明：全部已读
• 接口地址：rider/notify/already-read-msg.json
• 请求参数：

{
    typeId:int, // 1-公告，2-消息
    categoryId:int, // 种类id，只有在typeId=2的情况下会传
}

• 响应报文

{
    status:1,
    data:{},
}