开放平台
  1. 通讯录
开放平台
  • 开放平台 ReadMe
  • 加解签规则
  • 开放平台加解密规范(新)
  • 接口地址
  • 关于小程序
  • 最福利订单状态枚举
  • 最福利物流编码
  • 内部文档-不提供外部使用
  • 供应商
    • 收银订单-收银台对接-供应商使用
      • 免密登陆
      • 查询商品详细信息
      • 发起收银
      • 发起收银--同步保存商品明细
      • 取消订单
      • 收银异步通知
      • 查询交易记录
      • 发起退款申请
      • 退款异步通知
      • 退款状态查询
      • 跳转第三方订单详情页面
      • 发起收银-传输用户id
    • 登录相关
      • 跳转外部
        • 个人用户免密登录-跳转到外部(不推荐)
        • 网页授权登陆链接,获取访问用户身份(推荐)
      • 外部跳转最福利
        • 个人用户免密登录-代理版本
        • 个人用户免密登录-普通版本
  • 渠道方
    • 最福利收银台-积分在外部系统-渠道方使用
      • 余额查询
      • 发起交易
      • 发起退款
      • 订单状态推送
      • 交易分页查询
    • 第三方系统收银台-积分在外部系统-渠道方使用
      • 余额查询
      • 发起收银
      • 收银异步通知
      • 查询交易记录
      • 订单状态推送
      • 发起退款
    • 实物商城-api对接-渠道方使用
      • 类目查询
      • 商品列表
      • 查询同类商品
      • 商品详情
      • 商品价格查询
      • 商品库存查询
      • 地址详情转换地址编码
      • 查询省市区收货地址编码
      • 商品下单
      • 商品物流轨迹
      • 商品物流轨迹V3
      • 商品信息查询
      • 京东商品根据skuid查询商品详情
    • 订单系统
      • 确认订单(需传入用户信息)
      • 确认订单(渠道信息作为用户信息)
      • 订单状态变更异步通知
      • 查询订单信息(用户为公司用户)
      • 查询订单信息(需要指定buyerId)
    • 电子卡券对接
      • 电子卡对接ReadMe
      • 电子卡下单
        • 电子卡券下单-个人用户
        • 电子卡券下单-企业用户
      • 电子卡券列表
      • 电子卡券详情
      • 订单状态变更通知
      • 根据订单号查询卡号卡密
      • 电子卡券详情 Copy
    • 充值中心对接
      • 下单
      • 支付
      • 查询充值结果(与支持轮询充值的下单配套使用)
    • 充值1.0
      • 下单
      • 确认支付
      • 订单查询
      • 获取openId链接
      • 获取核销信息
  • 定制需求
    • 永辉
      • 发起收银--同步保存商品明细
      • 发起退款申请---支持退款指定商品
    • 众安订餐定制需求
      • 获取可见的加班餐商户
      • 查询指定商户售卖的套餐信息
      • 获取当前员工所属公司有哪些职场
      • 下单接口 并支付
      • 取消订单
    • 云学堂
      • oa调用稳赢云发消息
    • 体检
      • 【内】下单并静默支付并绑定使用手机号
      • 【内】下单并静默支付并绑定具体使用者信息
      • 下单并静默支付并绑定具体使用者信息
    • 众安十周年需求定制
      • 个人用户免密登录至众安【众安十周年需求】
      • 众安定制接口,根据手机号码查询基础信息
    • 实物商城卡券兑换
      • 给指定用户发放卡券
    • 机票/酒店对接外部渠道
      • 壹钱包对接
        • 航班舱位激励信息查询
        • 机票/酒店下单接口
        • 支付回调--供应商实现
    • 众安积分买保险
      • 相关密钥地址等信息
      • 众安积分买保险-下单并支付
      • 众安积分买保险-退款
  • ZALife
    • 查询部门信息
    • 查询员工信息
    • 企微消息通知
    • 网页授权登陆链接,获取访问用户身份(推荐)
  • 积分
    • 积分发放
    • 查询发放详情
    • 可用积分查询
  • 通讯录
    • 通用接口规范
    • 同步员工
      POST
    • 查询员工
      POST
    • 公司列表查询
      POST
    • 同步部门
      POST
    • 查询部门
      POST
  • 收银订单业务
    • 宜员收银订单标准接口文档
      • 宜员订单系统接入文档-加解密规则
      • 联合登录
      • 下单接口
      • 订单取消
      • 退款接口
      • 支付状态查询
      • 退款状态查询
      • 支付成功回调
      • 退款成功回调
      • 跳转订单详情页面
      • 错误码
    • 客户定制接口
      • 唯品会
        • 拆单后同步宜员系统
  • 开放平台-接口模版
    POST
  • 开放平台-接口模版(对接实例)
    POST
  1. 通讯录

通用接口规范

商务协议走完,最福利审核通过之后,会将对接账号ChannelCode,AppKey回复给申请方;

1、接口规范:#

1.1通用类型说明#

类型说明规则
DateTime时间日期类型YYYY-MM-DD HH:mm:ss
Date日期类型YYYY-MM-DD

1.2通用接口规范#

URL第三方提供
MethodPOST / application/x-www-form-urlencoded
请求参数IcareApiRequest
参数名称类型必填说明
serviceNameString是接口名称
versionString否接口版本号默认1.0
bizContentString否接口请求参数json字符串
formatString是bizContent格式固定json
charsetString是固定UTF8
timestampDatetime是请求时间
channelCodeString是渠道Code
signTypeString是固定MD5
signString是参照加解签规则
响应参数IcareApiResponse
参数名称类型必填说明
resultCodeString是请求结果code,0:成功,其他失败
resultDescString否请求结果描述
bizContentString否接口请求响应参数json字符串,无固定格式,根据业务而定
formatString是bizContent格式固定json
charsetString是固定UTF8
timestampDatetime是响应时间
signTypeString是固定MD5
signString是参照加解签规则
第三方用户信息GwUserInfo
参数名称类型必填说明
channelUserIdString是第三方用户唯一标识
custIdLong否最福利用户标识
phoneString是用户手机号码
nameString是用户姓名
emailString否用户邮箱

1.3加解签规则#

最福利使用https协议,只需要对请求的参数进行加解签即可.请对所有参数进行验签,最福利后续可能会新增字段
加签规则(排除sign,signType)
请求参数 s=XXXX,b=XXXX,a=XXXX
1.构建签名串:
对请求参数按照字母升序排序, a=XXXX,b=XXXX,s=XXXX
对参数名称,参数值utf8 进行URLEncodeing 且使用&拼接成参数串 a=XXXX&b=XXXX&s=XXXX
参数串+appKey
2.使用MD5算法对以上签名串进行加签,从而获取sign.ps:使用UTF8字符集
3.将sign作为请求参数,signType=MD5.
验签规则(排除sign,signType)
请求参数s=YYYY,b=YYYY,a=YYYY,sign=ab6e81f0adc128,signType=MD5
1.构建验签串
请求参数除sign按照字母升序排序a=YYYY,b=YYYY,s=YYYY
对参数名称,参数值utf8 进行URLEncodeing 且使用&拼接成参数串 a=YYYY&b=YYYY&s=YYYY
参数串+appKey
2.使用MD5算法对以上签名串进行加签,从而获取targetSign.ps:使用UTF8字符集
3.如果sign==targetSign验签成功.
上一页
可用积分查询
下一页
同步员工
Built with