API 开发文档
本教程由沈阳农业大学 大学生网络信息中心运行部提供,适用于校园网站开发
部门统一身份认证接口参考文档
部门统一身份认证(新)
POST 部门统一身份认证(新)
tips:
- DMII = Department Member Information Interface
- 该接口用于验证登录,获取部门成员信息。
- 该接口为新接口。启用时间:2025年7月20日,老接口仍能使用(不推荐)
- 该接口用于弥补老接口无法返回用户部门信息和任职,无法单独查询用户身份信息
POST http://210.47.163.181/DepartmentIFO/houtai/php/DMII.php
请求包体:
{
"kind":"",
"UserID":"",
"password":""
}
| 参数 | 必须 | 说明 |
|---|---|---|
| kind | 是 | 请求类型,包括:login和getUserInfo(未来可能会扩展) |
| UserID | 是 | 学工号 |
| password | 否 | 密码,仅有当kind为login时需要,既进行登录验证时需要 |
返回结果:
{
"errcode": ,
"errmsg": "",
"data": {
"id": "",
"UserID": "",
"name": "",
"department": "",
"posts": "",
"enable": ""
}
}
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| data | 当成功执行代码时返回用户信息,代码发生异常报错时,可能返回报错信息 |
| id | 用户在数据库中的id排序,为不可重复值 |
| UserID | 用户的学工号 |
| name | 用户姓名 |
| department | 用户所在部门 |
| posts | 用户职务,格式为级数+职位,只显示最新的职位 |
| enable | 用户当前状态,当值为0时表示该用户已被删除,为1时表示在职,为2时表示已退休,只有当达到副部长级别后,才会留名,既委员若未成功选举成为副部长,则直接为0删除 |
返回码对应情况
| 返回码值 | 说明 |
|---|---|
| 0 | 成功 |
| 400 | 请求参数为空值,未获取到请求包体 |
| 401 | 请求参数不完整,既kind或UserID存在为空 |
| 402 | 当执行登录验证时,登录失败,用户名或密码错误 |
| 403 | 当执行获取部门成员信息时,所请求学工号对应成员不存在 |
| 404 | 请求类型错误,既kind参数值不正确 |
| 500 | 连接数据库失败,此时会返回data数据值,显示错误原因 |
| 501 | 服务器错误,执行查询时出错,当执行登录验证时,查询数据库时出错 |
| 502 | 服务器错误,执行查询时出错,当执行获取部门成员信息时,查询数据库时出错 |
自建API参考文档
创建群聊
POST 创建群聊
该接口用于创建群聊,并返回群聊ID。
POST http://210.47.163.113/CreateGroupChatBackground/php/buildGroup.php
请求包体:
{
"owner":"",
"group_name": "",
"ChatProperties": "",
"userlist": ["userid1", "userid2", "userid3"],
}
| 参数 | 必须 | 说明 |
|---|---|---|
| owner | 是 | 群主的学工号 |
| group_name | 是 | 群聊名称 |
| ChatProperties | 是 | 群聊属性,详细见群聊属性命名规范 |
| userlist | 是 | 群成员id列表。至少2人,至多2000人 |
返回结果:
{
"code": 1,
"msg": "群聊创建成功",
"chatid": "chatid",
}
| 参数 | 说明 |
|---|---|
| code | 返回码,为1和101时成功,其余全部失败,101时存入数据库失败,但群聊创建成功 |
| msg | 对返回码的文本描述内容 |
| chatid | 群聊ID,若丢失可上数据库中查询,官方接口不再可获取 |
邀请,删除,发送群聊消息
POST 邀请,删除,发送群聊消息
该接口用于邀请,删除,发送群聊消息等群聊管理功能。
POST http://210.47.163.113/qywx/chatyq.php
请求包体:
{
"kind":""
"chatid": "",
"UserID": "",
"content": "",
}
| 参数 | 必须 | 说明 |
|---|---|---|
| kind | 是 | 请求类型,包括:chatCreate、chatDelete、chatSend |
| chatid | 是 | 群聊ID |
| UserID | 否 | 学号,当发送群聊消息时不需要 |
| content | 否 | 发送群聊消息内容,目前仅支持文本消息(未来可能会拓展),需要发送其它消息请直接调用官方接口 |
返回结果:
{
"errcode": 0,
"errmsg": "ok",
}
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |