数据推送第三方系统说明

此接口为外勤365平台在检测到到业务数据产生或变化时,通过发送HTTP请求,向第三方系统实时推送业务数据的接口说明。请求仅支持以POST方式提交请求,请求参数以表单Content-Type: application/x-www-form-urlencoded方式传输,超时时间为5秒。

第三方系统接收到外勤365发起的HTTP请求时,将业务数据处理完成后响应{"return_code":0}表示数据处理成功,{"return_code":1}表述数据处理失败。对于处理失败的数据外勤365将在每天凌晨0点重新发起失败重试,如果此后连续10天仍然失败,系统将不再重试。对于同步失败的数据第三方系统还可以通过查询失败信息接口getfail获取。

请求数据体格式说明

                
// 请求数据体格式示例:
msgId=6180692780723284516&dataType=employee&dataId=7087293505129744417&dataVersion=001&dataFormat=json&dataSource=biz&data=encode(XXXXXX)&timestamp=1524127928875&status=0&digest=b07a889d80bdb5db5a6626a78b684296&tenantId=5988656268372294520

                  
            
参数名称 参数值
接口URL 第三方服务接口URL
接口参数 参数名称 参数类型 参数描述
msgId String 消息ID
dataType String 数据类型,说明: dataType 数据类型,对应各功能值如下:
employee 员工
department 部门
custom_district: 销售区域
custom_type: 客户类型
custom: 客户信息
visit: 拜访记录
cuxiao_activity: 促销活动
cuxiao_record: 促销记录
cuxiao_record_check:促销记录检查
stdorder_order:标准订单
stdorder_sent:标准发货单
stdom_return:标准退货单
stdorder_carsale:标准车销单
dms_purchase:直营采购订单
dms_salesorder:分销销售订单
dms_sent:发货单
dms_sign:签收单
dms_inventory:盘点单
dms_cardistributeorder:车铺单
dataId String 数据ID
dataVersion String 接口数据版本,如:001
dataFormat String 数据格式:json
dataSource String 数据来源:biz 业务功能产生 api 开放接口产生
data String 请求数据体, 说明:格式为JSON格式数据
timestamp long 请求时间戳,如:1503276678552
status String 数据同步状态,0-数据首次同步 2-数据失败同步
statusTime String 上次同步失败时间,格式:yyyy-MM-dd HH:mm:ss
tenantId String 企业ID,各注册企业在外勤365中对应的唯一ID
digest String 数据签名,md5(data|appkey|timestamp)
响应信息 参数 类型 说明
return_code int 响应编码,0-成功, 1-失败
return_msg String 响应说明

// 请求消息体示例:
{
    "cm_id": "CM0001",
    "cm_name": "苏果夫子庙店",
    "cm_code": "suguo_fzmd"
}

// 响应信息示例:
{
    "return_code": 0,
    "return_msg": ""
}
                  
参数名称 参数值
接口URL https://sync.waiqin365.com/swap/getbydataid/{dataType}/{openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 ids:数据ID,多个数据用“,”分割
响应信息 return_code: 响应编码
return_msg: 响应消息内容
results[]: 查询结果记录数据,数据体和同步接口数据体格式一致

// 请求信息示例:
{
    "ids":"4980267531048822880,9004126148607423649"
}
// 响应信息示例:
{
    "return_code": 0,
    "return_msg": "",
    "results": [
        {
            "id": "消息ID",
            "dataType": "<<数据类型>",
            "dataId": "<<数据ID>",
            "dataVersion": "<<数据版本>",
            "dataFormat": "json",
            "createTime": "2016-07-14 18:30:23",
            "data": "<<请求数据体>"
        }
    ]
}
                  
参数名称 参数值
接口URL https://sync.waiqin365.com/swap/getfail/{dataType}/{openid }/{ timestamp }/{ digest }/{ msg_id }
说明:
dataType 数据类型,对应各功能值如下:
employee 员工
department 部门
custom_district: 销售区域
custom_type: 客户类型
custom: 客户信息
visit: 拜访记录
cuxiao_activity: 促销活动
cuxiao_record: 促销记录
cuxiao_record_check:促销记录检查
stdorder_order:标准订单
stdorder_sent:标准发货单
stdom_return:标准退货单
stdorder_carsale:标准车销单
dms_purchase:直营采购订单
dms_salesorder:分销销售订单
dms_sent:发货单
dms_sign:签收单
dms_inventory:盘点单
dms_cardistributeorder:车铺单
digest: 数据签名,md5(<<请求消息体>>|appkey|timestamp)
请求信息 空(空字符串)
响应信息 return_code: 响应编码
return_msg: 响应消息内容
results[]: 查询结果记录数据,数据体和同步接口数据体格式一致,每次查询返回条数100条

// 请求信息示例:
{}
// 响应信息示例:
{
    "return_code": 0,
    "return_msg": "",
    "results": [
        {
            "id": "消息ID",
            "dataType": "<<数据类型>>",
            "dataId": "<<数据ID>>",
            "dataVersion": "<<数据版本>>",
            "dataFormat": "json",
            "createTime": "2016-07-14 18:30:23",
            "data": "<<请求数据体>>"
        }
    ]
}
                  
参数名称 参数值
接口URL https://sync.waiqin365.com/swap/failconfirm/{dataType}/{openid }/{ timestamp }/{ digest }/{ msg_id }
说明:
dataType 数据类型,对应各功能值如下:
employee 员工
department 部门
custom_district: 销售区域
custom_type: 客户类型
custom: 客户信息
visit: 拜访记录
cuxiao_activity: 促销活动
cuxiao_record: 促销记录
cuxiao_record_check:促销记录检查
stdorder_order:标准订单
stdorder_sent:标准发货单
stdom_return:标准退货单
stdorder_carsale:标准车销单
dms_purchase:直营采购订单
dms_salesorder:分销销售订单
dms_sent:发货单
dms_sign:签收单
dms_inventory:盘点单
dms_cardistributeorder:车铺单
digest: 数据签名,md5(<<请求消息体>>|appkey|timestamp)
请求信息 ids:失败记录处理完成确认消息ID,逗号分隔
响应信息 return_code: 响应编码
return_msg: 响应消息内容
msg_id: 消息ID

// 请求消息体示例:
{
    "ids": "2000235510200010125,2000235510200010126,12000235510200010127"
}

// 响应信息示例:
{
    "return_code": 0,
    "return_msg": "",
    "msg_id": "X00002"
}