开发接口文档
  1. 前言
开发接口文档
  • 快跑者开放接口文档
    • 前言
      • 文档说明
      • 订单创建商户映射逻辑
      • 签名生成规则
    • 订单相关接口
      • 计算配送费
      • 创建订单
      • 获取订单详情
      • 获取订单进程
      • 获取订单配送员坐标
      • 订单增加小费功能
      • 配送订单出餐
      • 撤销订单
      • 评论配送员
      • 拉黑骑手
    • 联盟订单相关接口
      • 计算配送费
      • 创建订单
    • 团队相关接口
      • 获取团队信息
    • 商户相关接口
      • 获取所有商户
      • 解绑授权商户
      • 设置商家名称
      • 创建关联快跑者商户
      • 获取商家储备金余额及充值链接
      • 获取指定团队是否存在相关商户
    • 门店相关接口
      • 获取门店列表
      • 修改门店
      • 删除门店
      • 关联门店
    • 配送员相关接口
      • 获取所有配送员
      • 获取指定范围配送员
      • 解除拉黑骑手
    • 回调通知
      • 配送订单状态变更回调
    • 其他
      • 常见问题
      • 微盛小程序对接快跑者
  1. 前言

文档说明

文档说明#

本文档系快跑者 开放接口正式版 说明文档,在此之前,开放有测试版(V1、V2、V3 版)开放接口(https://github.com/LingdianIT-Com/keloop) ,经过一年多的开发迭代,快跑者系统已趋于稳定,现基于当前的业务流程,梳理整理正式版开放接口,所以请新开发者使用正式版开放接口,曾对接测试版开放接口的开发者也可升级到正式版,正式版开放接口结构更为清晰,开放的功能更为完善,对接和调试流程更有简单,你值得拥有!
欢迎加入快跑者开放接口微信群,具体加群方式请联系团队合作商务

接口使用流程#

1.
在快跑者 开放平台 注册开发者账号,完善开发者相关信息,并绑定微信(申请通过会通过微信进行通知),然后在「接口配置」页面查看开发密钥(dev_key)和签名密钥(dev_secret);
2.
注册快跑者 团队后台 账号,然后在「团队管理-团队信息」页面查看团队密钥(team_token);
3.
基于本开放接口文档进行对接;

接口简述#

简述:本文档系快跑者 开放接口正式版 说明文档,快跑者开放接口是向拥有开发能力的第三方系统开放快跑者相关功能和能力,主要开放的能力:
订单相关
创建订单
获取订单详情
获取订单进程
获取订单配送员坐标
评价配送员
计算配送费
撤销订单
【回调】订单状态变更时回调第三方系统
团队相关
获取团队信息
商户相关
获取团队合作的所有商户信息
配送员相关
获取团队合作的所有配送员信息

基本约定#

在文档描述过程中,为避免因描述模糊而致使开发者理解错误,特对部分关键词做如下约定:
第三方系统:接口的使用方,调用本文档接口的系统或平台(如餐饮外卖平台,本地电商平台)
快跑者系统:接口的提供方,向第三方系统开放订单操作能力
第三方订单:第三方系统的订单
配送订单:快跑者系统的订单
注:第三方订单和配送订单的关系:开发者在调用创建配送订单接口时,需要传递一些参数,如:订单内容、订单标识、订单备注等,可以将第三方系统订单的对应字段来赋值这些参数。

接口说明#

快跑者开放接口的请求方式主要分为 GET 和 POST 两种,一般获取数据时使用 GET 请求,提交或修改数据时使用 POST 请求,无论是 GET 请求还是 POST 请求,请求的数据的格式都是:application/x-www-form-urlencoded。
有特殊字符的使用 urlencode 转义一下
快跑者开放接口的返回数据为 JSON 格式,由以下三个字段组成:
code:状态码,取值有 200,204;200 表示接口调用成功, 204 表示接口调用失败
message:错误信息,当接口调用失败(状态码为 204)时,返回的错误提示信息
data:返回数据,接口调用成功(状态码为 200)时返回的数据

注:
PHP 开发者可直接获取并使用 [Keloop-PHP-SDK 及 Demo](本文档系快跑者 开放接口正式版 说明文档) 简化开放流程;
为保证接口调用安全,请求接口需对请求参数进行签名,开发者可参考 签名与验签说明 自由编写签名代码;
调用创建订单接口成功创建配送订单后,系统会返回配送订单单号:trade_no,请开发者保存好,用于后续查询和操作订单;
下一页
订单创建商户映射逻辑
Built with