国开.学习网-批改网合作

合作

一、约定

1. 请求方式

请求使用POST请求；openKey 要使用对称加密。 请求和数据传输使用 JSON。

POST http://url.com/api?sign=签名

2. 签名

提交过来的json字符串 跟 openKey 加密

<?php
$str= file_get_contents("php://input");
$sign = md5($str . $openKey);

3. 统一返回格式

二、布置作文题目API

post http://url.com/ouchn/request?sign=签名

1. 请求

Json body

{
"openId":"布置老师的UID 认证中心的唯一id useridcode",
"taskId":"任务ID",
"taskTitle":"任务标题 我们做作文的题目",
"taskRequest":"任务要求 我们做作文的要求",
"start":"2023-01-02 13:20:01", //答题开始时间
"end":"2023-02-03 23:59:59", //答题截止时间
"userNo":"用户工号",
"taskFatherId":"父节点的任务ID, 如果没有请留空"
}

请求字段说明

2. 返回

返回体Json

{
error:0,
errorDes:""
data:{
"taskId":"学习网任务ID",
"openId":"布置老师的UID 认证中心的唯一id useridcode"
"pigaiRequestId":"批改网题目ID",
"url":"https://..... 链接跳转到批改网进行高级设置",
"taskUrl":"https://..... 链接跳转到批改网答题",
}
}

返回体字段说明（data部分）

三、成绩回传设计

POST https://xuexi.com/api?sign=签名

回传回学习网设计

1. 请求

json body

{
"openId":"用户 认证中心的唯一id useridcode",
"taskId":"学习网任务ID",
"pigaiRequestId":"批改网题目ID",
"score":"成绩 67.45 保留2位有效小数",
"type":"1或者2 1机器打分 2人工打分",
"time":"2023-01-10 18:20:01" ,//提交时间
"url":"https://www.pigai.com/ouchn/essay/xxx 学生查阅地址",
"editUrl":"https://www.pigai.com/ouchn/***/xxx 教师可批改地址",
"pigaiEssayId":"批改网作文内容ID 用于单篇删除",
"userNo":"用户工号"
}

回传请求字段说明

2. 返回

{
error:0,
errorDes:"ok"
}

四、修改作文题目API

post http://url.com/ouchn/requestModify?sign=签名

1. 请求

Json body

{
"openId":"布置老师的UID 认证中心的唯一id useridcode",
"taskId":"任务ID",
"taskTitle":"任务标题 我们做作文的题目",
"taskRequest":"任务要求 我们做作文的要求",
"start":"2023-01-02 13:20:01", //答题开始时间
"end":"2023-02-03 23:59:59", //答题截止时间
}

请求字段说明

2. 返回

返回体Json

{
error:0,
errorDes:""
data:{
"taskId":"学习网任务ID",
"openId":"布置老师的UID 认证中心的唯一id useridcode"
"pigaiRequestId":"批改网题目ID",
"pigaiRequestTime":"2023-01-17 10:10:59",
"url":"https://..... 链接跳转到批改网进行高级设置"
}
}

返回体字段说明（data部分）

五、删除作文题目

删除题目时，会想将题目下的作文也相应的删除

post http://url.com/ouchn/requestDel?sign=签名

1. 请求

Json body

{
"taskId":"任务ID",
"pigaiRequestId":"批改网题目ID"
}

请求字段说明

2. 返回

返回体Json

{
error:0,
errorDes:""
data:{
"taskId":"学习网任务ID",
"pigaiRequestId":"批改网题目ID",
"stats":"success 删除成功，fail 删除失败",
"delEssayCnt":"10 本题目下的作文作文"
}
}

返回体字段说明（data部分）

六、删除作文

post http://url.com/ouchn/essayDel?sign=签名

1. 请求

Json body

{ 
"pigaiEssayId":"批改网作文内容ID 成绩回传中有记录"
}

请求字段说明

2. 返回

返回体Json

{
error:0,
errorDes:""
data:{ 
"stats":"success 删除成功，fail 删除失败" 
}
}

返回体字段说明（data部分）