使用说明:注意在微信内的使用
1、企业H5若涉及个人支付、则不支持在微信小程序中使用(不支持微信小程序支付);全额企业付则可在小程序中使用
2、微信公众号中可以使用
获取方式见 1.1 接入流程
特别注意:
创建应用的接入模式选择:H5
创建应用的所需API选择:H5免登接口、企业用车接口、企业管理接口
1.使用绿色公务企业管理员账号登录绿色公务后台:http://www.vipcaocao.com/login
2.登录后,用车管控-用车规则管理,创建用车规则
用车规则创建参考 创建用车规则
3.为企业员工匹配规则
使用企业H5需要设置规则:企业员工——全员用车详情——规则设置
注:员工用车规则设置参考 为员工分配用车制度
H5接入域名
沙箱环境:sandbox-mobile.caocaokeji.cn
正式环境:mobile.caocaokeji.cn
企业H5请求方式
正式环境请求,即使用正式环境域名、client_id 和 sign_key 即可
需要注意的是,企业H5的url路径为 enterprise-travel ,区别于个人H5的 pay-travel
链接生成使用get方式带入对应参数,并通过跳转链接传递给WebApp,测试环境请求示例见下:
签名方式:对下表标注了“参与签名”的参数组成参数对(未标注的不参与签名),并进行升序排序,组装成字符串,然后进行sha1签名得到结果。 签名具体方法见 1.3 签名认证
【用车规则管控参数说明】:当前为新版本,用车规则请在曹操企业管理后台管控;
仅无首页&地图的老版本支持传入时间地点等管控参数,如需使用规则参数,请在接入初期告知曹操
参数名 | 是否必填 | 说明 |
---|---|---|
client_id | Y | 开放平台管理中心创建应用获取(参与签名) |
timestamp | Y | 时间戳(毫秒)(参与签名) |
ext_user_id | Y | 第三方用户ID,第三方唯一标识,ID由第三方生成(参与签名) |
ext_user_phone | N | 实际叫车人手机号(如果url中传递,则参与签名) |
ext_user_name | N | 实际叫车人用户名(如果url中传递,则参与签名) |
user_type | Y | 传入1,表示企业用户(参与签名) |
rule_ids | N | 员工用车规则,公务后台创建后,从“3.1获取企业规则”获取id(参与签名) -可传入多个,用英文,分隔。但同一个用车场景下只可以传入一个规则 -规则更新说明:传入则更新为实际传入结果、不带入保持原规则 |
city_codes | N | 员工常驻城市,城市code从“2.1城市服务开通状态”获取(参与签名) -最多传入5个城市code、用英文,分割 -更新说明:传入则更新为实际传入结果、不带入保持原城市 |
company_limit_fee | N | 每笔订单企业支付金额,超过则在订单结束后需要用户个人支付,单位:分(如果url中传递,则参与签名) |
start_range | N | 起点限制范围,超出范围之外不能下单,每一组中包含三项内容(经度, 纬度, 半径[单位:米,正整数,1-3000米]),每一组之间以下划线"_" 分隔,组内三项内容也以下划线"_" 分隔(如果url中传递,则参与签名); |
end_range | N | 终点限制范围,超出范围之外不能下单,格式同上(如果url中传递,则参与签名) |
sign | Y | 免登签名(签名方式参考下方示例) |
phone | N | 乘车人手机号,若不传入,用户需要输入乘车人手机号才能叫车 |
phoneType | N | 0 可修改; 1 不可修改 |
useTime | N | 用车时间,格式为时间戳,预约单用车时间必须大于等于当前时间30分钟,不超过当前时间往后72小时 |
useTimeType | N | 0 可修改; 1 不可修改 |
start_time | N | 用车时间范围开始时间控制,格式为时间戳,传入后不支持修改 |
end_time | N | 用车时间范围结束时间控制,格式为时间戳,传入后不支持修改 |
start_city_codes | N | 起点城市范围控制,有多个用逗号(小写)隔开,传入后不可修改(开通城市citycode通过文档2.1接口获取) |
end_city_codes | N | 终点城市范围控制,有多个用逗号(小写)隔开,传入后不可修改(开通城市citycode通过文档2.1接口获取) |
startLg | N | 起点经度,高德坐标系(h5获取定位存在不稳定情况,接入方可传入起点经纬度提高用户的体验) |
startLt | N | 起点纬度 |
startType | N | 0 起点可修改; 1 起点不可修改 |
endLg | N | 终点经度 |
endLt | N | 终点纬度 |
endType | N | 0 终点可修改; 1 终点不可修改 |
start_name | N | 传入的地点名称将展示在起点输入框内,仅在传入起点经纬度时有效。传入的名称同时会在司机端展示,请保障名称正确性,最多30个字 |
end_name | N | 传入的地点名称将展示在终点输入框内,仅在传入终点经纬度时有效。传入的名称同时会在司机端展示,请保障名称正确性,最多30个字 |
order_types | N | 控制订单类型:1 实时单;2 预约单;3 接机单;4 送机单;5 包车单 |
service_types | N | 控制服务车型:2 新能源;3 舒适型;4 豪华型;5 商务型;7 优选 |
canSecondCall | N | 该字段控制订单结束或订单取消后是否可以在H5页面继续用车 建议接入的场景:需要严控每次下单必须从接入方入口进曹操H5用车页(比如每笔订单都需带入callback_info、用车规则参数) true 可以继续叫车(默认true)、继续叫车场景初始进入页面带入的callback_info会丢失; false 不可继续叫车,订单结束/取消后跳转至用车结束页,如需继续用车,需要用户关闭H5用车页,再重新进入 |
scene | N | 用车场景,进入对应用车场景:1加班 2出差 4日常 5接待 6其他 若该企业未创建对应用车场景或未传此字段,则展示所有用车场景 |
route | N | 控制打开用户的页面,用户标识以第三方用户ID为准。journey:打开用户的订单列表;orderDetail:打开用户对应订单号的订单详情页(需要配合orderNo一起使用) |
orderNo | N | 当route=orderDetail时必传,orderNo为曹操订单号,订单号可通过5.3订单状态变更回调获取 |
order_enterprise_remark | N | 订单企业备注(传入后在企业对账单中展示),长度最多30个字 |
callback_info | N | 备注字段,订单事件变化回调通知会推送该备注 |