# 事件通知接口实现
# 注意：该接口由开发者在开发者服务端实现，供OSX短说调用
### OSX短说后台填写接口地址
```
<pre class="calibre26">
```
https://[接口地址] 如：https://my.apk.com/userActionNotify
```
```
#### 请求参数约定(Get请求方式传参)
参数 是否必须 参数类型 限制长度 参数说明 user\_token 是 string 255 用户唯一性标识，对应唯一一个用户且不可变 to\_user\_token 是 string 255 没有值时传0，操作对象所属方，如收藏的帖子的user\_token，关注操作的被关注对象user\_token to\_id 是 string 255 没有值时传0，行为对象id，如发帖的帖子id，评论、点赞的帖子id action 是 string 255 行为标识，具体参照[OSX用户行为列表](http://oa.xiangtian.ren/index.php?mod=corpus&op=list&cid=58#fid_614) action\_token 是 string 255 本次行为的唯一标识，用于请求重试机制中的去重。 appKey 是 string 255 接口appKey，应用的唯一标识(OSX后台获取) endtimestamp 是 String 20 请求有效期，截止有效时间。1970-01-01开始的时间戳，秒为单位。 sign 是 string 255 MD5签名，详见 [【签名校验规则】](http://oa.xiangtian.ren/index.php?mod=corpus&op=list&cid=58#fid_618)#### 接口返回json格式示例
\> **json格式中主要包含data字段，data字段下是user\_token、userInfo 分别保存了用户唯一标识以及用户信息**
```
<pre class="calibre26">
```
{
"code":200,
"msg":"ok",
"data":{
"action_token":"本次行为的唯一标识",
"user_info":{//行为后，操作用户的积分最终值（积分有变动时，返回，无变动的可不返回）
"user_token":"用户唯一性标识",
"score1":"exp，经验值。等级可由经验值换算，换算规则可在OSX短说后台配置",
"score2":"社区积分",
"score3":"购物积分",
"score4":'贡献值',
"score5":'自定义积分类型1',
"score6":'自定义积分类型2',
"score7":'自定义积分类型3',
"score8":'自定义积分类型4',
"score9":'自定义积分类型5'
},
"to_user_info":{//行为后，被操作用户的积分最终值（积分有变动时，返回，无变动的可不返回）
"to_user_token":"用户唯一性标识",
"score1":"exp，经验值。等级可由经验值换算，换算规则可在OSX短说后台配置",
"score2":"社区积分",
"score3":"购物积分",
"score4":'贡献值',
"score5":'自定义积分类型1',
"score6":'自定义积分类型2',
"score7":'自定义积分类型3',
"score8":'自定义积分类型4',
"score9":'自定义积分类型5'
},
}
}
```
```
```
<pre class="calibre26">
```
{
"code":200,
"msg":"error",
"data":"操作失败"
}
```
```
#### 返回参数约定（OSX短说会根据返回的参数名列表更新OSX平台上对应用户信息）
参数 是否必须 参数类型 限制长度 参数说明 msg 是 string 255 操作结果的判断标识，‘ok’:本次请求成功；‘error’:本次请求失败 data 是 string 255 返回数据，请求失败时，这里保存失败原因说明 data.action\_token 是 string 255 本次行为的唯一标识，重试机制中重要参数，防止异常 data.userInfo.nickname 是 string 25 用户昵称 data.userInfo.phone 否 string 20 用户手机号 data.userInfo.avatar 否 String 255 头像地址 data.userInfo.real\_name 否 string 25 真实姓名 data.userInfo.sex 否 int 2 性别，0：保密，1：男，2：女 data.userInfo.birthday 否 int 11 生日，1970-01-01开始的时间戳，秒为单位 data.userInfo.qq 否 string 25 qq号 data.userInfo.signature 否 string 100 个性签名，个人心情、状态描述 data.userInfo.score1 否 string 25 exp，经验值。等级可由经验值换算，换算规则可在OSX短说后台配置 data.userInfo.score2 否 string 25 fly，社区积分 data.userInfo.score3 否 string 25 buy，购物积分 data.userInfo.score4 否 string 25 gong，贡献值 data.userInfo.score5 否 string 25 one，自定义积分类型1 data.userInfo.score6 否 string 25 two，自定义积分类型2 data.userInfo.score7 否 string 25 three，自定义积分类型3 data.userInfo.score8 否 string 25 four，自定义积分类型4 data.userInfo.score9 否 string 25 five，自定义积分类型5#### OSX短说实际调用接口地址示例:
```
<pre class="calibre26">
```
https://my.apk.com/userActionNotify?user_token=14359234985&to_user_token=14359234956&to_id=256&action=osx_thread_add&action_token=1520559498658924&endtimestamp=1520559858&appKey=testappKey&sign=284dd169610caa4305b8e255830ad9de
```
```
### 注意事项
1. OSX发起的请求默认会带上请求有效期、appKey以及sign签名；开发者服务端可以根据请求接口参数验证请求来源的安全性。如开发者服务端不做相关校验，将可能导致平台重要信息泄露，由此造成的损失OSX短说概不负责。
2. 该接口有重发机制，开发者服务端需对重复请求做检测过滤，否知可能会导致同一个用户行为被多次处理，加了多次积分等，由此造成的损失OSX短说概不负责。
3. 由于可能存在开发者服务端响应了，但是OSX服务端没收到响应的情况，所以开发者服务端检测到重试请求时，也要按照接口返回格式返回相关数据，而不是返回报错信息，方便OSX服务端更新用户最新数据信息。
