平台基础数据同步接口文档

知识元

更新历史

目录

【备注】

1. 全局返回码说明

每次调用接口时，可能获得正确或错误的返回码，开发者可以根据返回码信息调试接口，排查错误。

HTTP请求状态返回格式

错误样例
{
"status": 403,
"message": "Forbidden",
"code": "40410"
}
成功样例
{
"status": 200,
"data": {"access_token":"ACCESS_TOKEN","expires_in":7200}
}

1.平台鉴权

1.1 获取平台级鉴权证书

接口地址

/v1/channel/token

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
RequestBody
appid	是	String	第三方平台唯一凭证
secret	是	String	第三方平台唯一凭证密钥，即appsecret

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d http://v.sewise.com/v1/channel/token
Response
{"status":200,"data":{"access_token":"olC9LNQLkTmbGY8kk8RSGzVn1hcb4ITbSQcjpKTN","expire":"2018-07-18 17:08:43"}}

1.2 续租平台级鉴权证书（续租24小时）

接口地址

/v1/channel/token

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
RequestBody
access_token	是	String	当前未平台级鉴权证书

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d http://v.sewise.com/v1/channel/token
Response
{"status":200,"data":{"access_token":"olC9LNQLkTmbGY8kk8RSGzVn1hcb4ITbSQcjpKTN","expire":"2018-07-18 17:11:08"}}

2.学校基本数据

2.1 同步新增/更新学校

接口地址

/v1/abutment/syncSaveOrganMetadata

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
RequestBody
access_token	是	String	平台级鉴权证书
organName	是	String	学校/机构名称
organKind	是	Int	学校/机构类型: 1:小学，2:初中，3:高中，4:大学，5:其他
provinceName	是	String	省，如：广东省
cityName	是	String	市，如：深圳市
areaName	是	String	区/县，如：南山区
otherId	是	Long	来源方平台的原学校/机构ID

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d http://v.sewise.com/v1/abutment/syncSaveOrganMetadata
Response
{"status":200,"message":"success","data":{"access_token":"uUvPT5nF2jpoJETmH9hj4d7jkFjBC3NAMueehdid","organName":"\u56e0\u5c1a\u6df1\u5733\u4e2d\u5b66","organKind":"2","provinceName":"\u5e7f\u4e1c\u7701","cityName":"\u6df1\u5733\u5e02","areaName":"\u5357\u5c71\u533a","otherId":"2238234"}}

2.2 删除学校

接口地址

/v1/abutment/syncDeleteOrganMetadata/{otherId}

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
ParamsBody
otherId	是	Long	来源方平台的原学校/机构ID

请求参数

参数	必选	类型	说明
RequestBody
access_token	是	String	平台级鉴权证书

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d http://v.sewise.com/v1/abutment/syncDeleteOrganMetadata/{otherId}
Response
{"status":200,"message":"Delete success"}

2.3 新增/修改班级

接口地址

/v1/abutment/syncSaveClassMetadata

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
RequestBody
access_token	是	String	平台级鉴权证书
className	是	String	班级名称
gradeName	是	String	年级名称/级届
otherSchoolId	是	Long	来源方平台的原学校/机构ID
otherId	是	Long	来源方平台的原班级ID

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d http://v.sewise.com/v1/abutment/syncSaveClassMetadata
Response
{"status":200,"message":"success","data":{"access_token":"uUvPT5nF2jpoJETmH9hj4d7jkFjBC3NAMueehdid","className":"\u5c16\u5b501\u73ed","gradeName":"2018\u7ea7","otherSchoolId":"2018","otherId":"30099"}}

2.4 删除班级

接口地址

/v1/abutment/syncDeleteClassMetadata/{otherId}

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
ParamsBody
otherId	是	Long	来源方平台的原班级ID

请求参数

参数	必选	类型	说明
RequestBody
access_token	是	String	平台级鉴权证书

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d http://v.sewise.com/v1/abutment/syncDeleteClassMetadata/132
Response
{"status":200,"message":"Delete success"}

2.5 新增/修改用户

接口地址

/v1/abutment/syncSaveUserMetadata

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
RequestBody
access_token	是	String	平台级鉴权证书
uid	是	Int	第三方平台的用户uid
event	否	String	事件：1. new 新增，2.默认不填则是修改(没有记录时新增)
username	否	String	用户名
type	否	Int	用户类型：1.学生 2.老师(默认)
sex	否	Int	性别：0.男 1.女
faceIn	否	String	人脸识别头像
otherSchoolId	否	Long	来源方平台的原学校/机构ID
otherClassId	否	Long	来源方平台的原班级ID

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d http://v.sewise.com/v1/abutment/syncSaveUserMetadata
Response
{"status":200,"message":"success","data":{"access_token":"uUvPT5nF2jpoJETmH9hj4d7jkFjBC3NAMueehdid","username":"\u56e0\u5c1a\u5b66\u751f\u5f20\u5c0f\u51e1","type":"1","sex":"0","faceIn":"http:\/\/oss.sewise.com\/1139487293723","uid":"110","otherSchoolId":"2018","otherClassId":"30099"}}

2.6 删除用户

接口地址

/v1/abutment/syncDeleteUserMetadata/{uid}

HTTP Content-Type / 请求方式

application/json
POST

请求参数

参数	必选	类型	说明
ParamsBody
uid	是	Int	来源方平台的原用户UID

请求参数

参数	必选	类型	说明
RequestBody
access_token	是	String	平台级鉴权证书

HTTP 响应状态

200

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d http://v.sewise.com/v1/abutment/syncDeleteUserMetadata/132
Response
{"status":200,"message":"Delete success"}