API开放平台

TIP

# 查询客户帐号

请求方式： POST（HTTPS）
请求地址： https://{region}/api/smOuterUser/v1/querySmOuterUser/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "user_code": "13218014444"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
user_code VARCHAR(100) 否 根据客户帐号精确查询
user_name VARCHAR(100) 否 根据客户账号的姓名模糊查询
create_date CHAR(10) 否 根据创建日期查询用户,格式：“yyyy-MM-dd”
modify_date CHAR(10) 否 根据修改日期查询用户，格式：“yyyy-MM-dd”

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
    {
        "cm_code": "0000000003",
        "last_use_time": "2019-02-26 17:20:23",
        "type_name": "经销商B",
        "create_time": "2018-05-31 14:23:19",
        "is_main": "1",
        "cm_name": "up",
        "linkman_mobile": "13218014444",
        "linkman_id": "5879291146458501371",
        "operate_name": "系统自动创建",
        "linkman": "up主",
        "certification": 0,
        "status": "1"
    },
    {
        "cm_code": "CUS000012",
        "last_use_time": "2019-02-27 15:48:15",
        "type_name": "a1",
        "create_time": "2018-06-12 14:22:08",
        "is_main": "1",
        "cus_acc_roles": "4847172605794894550:员工(门店),4847172605794894550:老板(门店)",
        "cm_name": "down",
        "linkman_mobile": "13218014444",
        "linkman_id": "7493309492298543266",
        "operate_name": "系统自动创建",
        "linkman": "down老板",
        "certification": 0,
        "status": "1"
    }   
]

参数说明：

参数 类型 必填 说明
linkman_id VARCHAR(32) 是 联系人ID
linkman_mobile VARCHAR(32) 否 联系人手机号码
linkman VARCHAR(100) 否 联系人姓名
is_main VARCHAR(1) 否 是否主联系人,1是、0否
cus_acc_roles VARCHAR(500) 否 客户账号角色[ID1:名称1，ID2:名称2...]
cm_code CHAR(1) 否 客户编码
cm_name VARCHAR(12) 否 客户名称
type_name VARCHAR(13) 否 客户类型
create_time VARCHAR(20) 否 开通时间，格式：“yyyy-MM-dd HH:mm:ss”
operate_name VARCHAR(20) 否 最近操作人
last_use_time CHAR(10) 否 最近登录时间，格式：“yyyy-MM-dd HH:mm:ss”
certification VARCHAR(500) 否 该客户账号是否实名认证
status VARCHAR(100) 是 状态，1正常、0删除

# 推送客户账号数据

勤策平台在客户账号基础信息发生变化时向第三方系统推送数据接口

请求方式： POST（HTTPS）
请求地址： 第三方服务接口URL
请求参数：

参数名称 参数值
msgId 消息ID
dataId 数据ID
dataVersion 接口数据版本，如：001
dataFormat 数据格式：json
dataSource 数据来源：biz 业务功能产生 api 开放接口产生
timestamp 请求时间戳，如：1503276678552
status 数据同步状态，0-数据首次同步 2-数据失败同步
statusTime 上次同步失败时间，格式：yyyy-MM-dd HH:mm:ss
tenantId 企业ID，各注册企业在勤策中对应的唯一ID
digest 数据签名，md5(data|pushsecret|timestamp)
dataType sm_outer_user 客户账号
data <<请求数据体>> ， 说明：格式为JSON格式数据

请求数据体：

[
  {
          "cm_code": "0000000003",
          "last_use_time": "2019-02-26 17:20:23",
          "type_name": "经销商B",
          "create_time": "2018-05-31 14:23:19",
          "is_main": "1",
          "cus_acc_roles": "4847172605794894550:员工(门店),4847172605794894550:老板(门店)",
          "cm_name": "up",
          "linkman_mobile": "13218014444",
          "linkman_id": "5879291146458501371",
          "operate_name": "系统自动创建",
          "linkman": "up主",
          "certification": 0,
          "status": "1"
      },
      {
          "cm_code": "CUS000012",
          "last_use_time": "2019-02-27 15:48:15",
          "type_name": "a1",
          "create_time": "2018-06-12 14:22:08",
          "is_main": "1",
          "cm_name": "down",
          "linkman_mobile": "13218014444",
          "linkman_id": "7493309492298543266",
          "operate_name": "系统自动创建",
          "linkman": "down老板",
          "certification": 0,
          "status": "1"
      }   
]

参数说明：

参数 类型 必填 说明
linkman_id VARCHAR(32) 是 联系人ID
linkman_mobile VARCHAR(32) 是 联系人手机号码
linkman VARCHAR(100) 是 联系人姓名
is_main VARCHAR(1) 是 是否主联系人,1是、0否
cus_acc_roles VARCHAR(500) 否 客户账号角色[ID1:名称1，ID2:名称2...]
cm_code CHAR(1) 否 客户编码
cm_name VARCHAR(12) 否 客户名称
type_name VARCHAR(13) 否 客户类型
create_time VARCHAR(20) 否 开通时间，格式：“yyyy-MM-dd HH:mm:ss”
operate_name VARCHAR(20) 否 最近操作人
last_use_time CHAR(10) 否 最近登录时间，格式：“yyyy-MM-dd HH:mm:ss”
certification VARCHAR(500) 否 该客户账号是否实名认证
status VARCHAR(100) 是 状态，1正常、0删除

响应示例：

{
    "return_code": 0,
    "return_msg": ""
}

参数说明：

参数 类型 说明
return_code int 响应编码，0-成功, 1-失败
return_msg String 响应说明

← 人员附加信息管理 →