盖格.测评家作为专业的测评服务提供商,为更好满足业务合作伙伴的需要,提供API接入等方式,让合作伙伴利用的在线平台(微信公众号、APP、网站)接入测评家测评数据服务。通过接入,让合作伙伴可以灵活定义测评使用流程,让用户可直接在合作伙伴的在线平台上使用测评服务。接入的合作伙伴可同步享受盖格.测评家最新开发与迭代测评内容,更有效实现业务目的。
接入服务主要面向企业、正规机构。所有接入方均需在测评家平台完成注册、认证后可提交接入申请。
不同的测评内容或项目,我们称之为“测评工具”(如:销售岗潜能测评)。每个工具都有其特定的作用与适用范围,通过选用测评工具并完成相应测评,我们可以获得对应的测评报告。测评工具分为两种类型,区别在于测评形式:单人测评,是单个人完成测评并出具报告;团队测评,是一群人参与的测评,仅生成一份报告。
每个测评任务对应1个人,测评报告是对此人的测评分析。该类测评主要用于招聘、评估人员,选拔人员,自我认知,个人咨询等场景。接入方可在前端开发的流程可有多种形式:自评式,自己发给自己测评,掌握自己情况;评他人,生成测评任务,他人完成测评答题,测评他人情况。
每个测评任务对应一群人。这一群人对测评对象进行评价,以掌握一群人对某个测评对象(如对某部门、某事情、某个人)的看法,该类测评多用于调查。接入方在前端开发的流程可参考为:用户生成测评任务,收到该任务的人员完成测评后,生成一份总体的测评报告。

1、在网页上输入http://www.cepingjia.net;进行注册/登录;

2、如果您还没有进行企业认证,请在登录后进行企业认证(如下图所示)点击立即进入企业认证;

1、在网页上输入http://www.cepingjia.net/EvaluationHome/co/apiBrief;进入API接入介绍页面;

2、点击“申请接入”按钮进行API接入操作(如下图所示)

公司:盖格网络技术有限公司
产品:测评家
版本:1.1.0
日期:2017/09/26 10:05

统一请求前缀
https :https://open.cepingjia.net/gaigo-open-shre/api

header
Content-Type : application/x-www-form-urlencoded; charset=UTF-8


基础接口

0_1. 账户登录

接口说明:接入方账户校验与登录。返回UID、CID、TOKEN,和版本号、测评家提供的APPKey、时间戳,生成接口的系统参数。其中UID,CID为固定数据,TOKEN为动态密钥,每次请求分配一组。 建议每2~4小时请求一次;

接口地址: /account/checkAccount.htm
请求方法: post
Auth-date:[add by Sanjy]

请求格式:

params= { "uname": "1866XXXXXXX", "password": "DC483E80A7A0BD9EF71D8CF973663934", "acctype": "1" }

params: 必填 接口入口参数

uname: 必填 测评家账号
password: 必填 账号密码 MD5(32位)加密。例:X.MD5.UpperCase
acctype: 必填,且为1

返回格式:

json { "code": "200", "data": { "cid": "efe3XXXX-XXXX-11e7-a2d0-02004c4f4f50", "cname": "咯哦哦", "token": "MTEwMzczc3I2aA==", "uid": "4191XXXX-XXXX-11e7-a2d0-02004c4f4f50", "uname": "黄黄小" }, "message": "Success." }

code:返回码, 200为正常,其他均为异常
message:对应code解释
data:uid,cid,token用来和APPKey组装系统参数

uid:接入帐号ID
cid:接入公司ID
token:动态码
cname:接入公司名称
uname:接入帐户名称

系统参数示例:

sysParam = { "version":"1.1.0", "appKey":"0001", "timeStamp":"000000000", "sign":"" }

version:设置为本接口文档的版本号
appKey:分配的appkey
timeStamp:每次接口请求的时间戳 System.currentTimeMillis()
sign:秘钥

秘钥(sign)生成示例:

需要参与加密的参数,按照ASCII排序如下:

appKey:000
cid:000
timeStamp:000
token:000
uid:000
version:1.1.0

待加密的字符串格式如下:

appKey=000&cid=000&timeStamp=000&token=000&uid=000&version=1.1.0

加密,采用MD5(32位)加密,示例:

X.MD5.UpperCase


0_2. 合作企业账户入驻

接口说明:本接口用于接入方的合作企业入驻到接入方系统账户

接口地址: /account/companyRegister.htm
请求方法: post
Auth-date:[add by Sanjy]

请求格式:

params = { "company": { "customeName": "这个测试的公司", "customeUname": "这是测试", "customeUtel": "1322222222", "settlementMethod": "vip", "cutOffTime": "2017-09-30 10:00:00", "taskNumber": 100, "customeScale": 100000 }, "sysParam": "{}" }

params: 必填 接口入口参数

sysParam: 系统参数,参考0_1中示例; company: 必填 入驻企业信息;

customeName:必填,48字以内 企业名称,不可重复
customeUname:必填,48字以内 企业负责人名称
customeUtel:必填 手机号码,做为登录账户,不可重复
settlementMethod:必填 计费方式。vip:包年/时段;times:按次
cutOffTime:截止时间,若计费方式选择按包时段(vip),则该属性必填
taskNumber:测评限制次数,若计费方式选择按次(times),则该属性必填
customeScale:必填 企业规模

返回格式:

json { "code": "200", "message": "Success." }

code:返回码, 200为正常,其他均为异常
message:对应code解释


0_3. 合作企业账户登录

接口说明:本接口用于接入方的合作企业登录,返回合作企业的UID和CID等信息,供后续组合企业company信息。

接口地址: /account/companyLogin.htm
请求方法: post
Auth-date:[add by Sanjy]

请求格式:

params = { "customeUtel": "13211221075", "sysParam":{} }

params: 必填 接口入口参数

sysParam: 系统参数,参考0_1中示例;

customeUtel:必填 企业入驻时的手机号码

返回格式:

json { "code": "200", "data": { "customeCid": "b1d1ce30-a41f-11e7-b7ca-408d5cc3e2a3", "customeUid": "b1cc91a5-a41f-11e7-b7ca-408d5cc3e2a3", "customeCname": "这个是司兄测试接入方的公司5", "customeUname": "这个是司兄" }, "message": "Success." }

code:返回码, 200为正常,其他均为异常
message:对应code解释
data: 企业的基本信息

customeCid:注册企业的id
customeUid:企业注册人的id
customeCname:注册企业的名字
customeUname:企业注册人的名字


工具接口

1_1. 获取可用工具列表

接口说明:本接口用于接入方获取可用的测评工具列表;分页查询

接口地址: /survery/getToolList.htm
请求方法: post
Auth-date:[add by Sanjy]

请求格式:

params = { "pageNum": 1, "numOfPage": 10, "sysParam": { "version":"1.1.0", "appKey":"0001", "timeStamp":"000000000", "sign":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" } }

params: 必填 接口入口参数

pageNum: 必填 当前查询页,从1开始
numOfPage: 必填 每页条数
sysParam: 系统参数,参考0_1中示例

返回格式:

json { "code": "200", "data": { "beginPageIndex": 1, "currentPage": 1, "endPageIndex": 1, "numPerPage": 10, "pageCount": 1, "recordList": [ { "toolNo": "A0013CM02-GE010", "toolName": "企业执行力成熟度测评", "toolImgUrl": "http://www", "reportStyle": "single", "shortContext": "掌握企业拿结果的能力", "toolBrief": "执行力,就是达成目标,形成结果的能力。执行力代", "toolDetailNum": 0, "toolPrice": "9.90", "toolState": "Ok", "toolTag": "执行力", "toolType": "Common", "toolUseNum": 0, "field1": "", "remark": "", "createTime": 1506485323000, "version": 0 } ], "totalCount": 1 }, "message": "Success." }

code:返回码, 200为正常,其他均为异常
message:对应code解释
data: 数据

beginPageIndex:起始页
currentPage: 当前页
endPageIndex:结束页
numPerPage:每页设置条数
totalCount:总条数
recordList:JSONArray,每一项代表一工具

toolNo:工具编号
toolName:工具名称
toolImgUrl:工具图片地址
shortContext:工具一句话概括
reportStyle:报告方式 见表1:报告方式
toolBrief:工具简介
toolDetailNum:查看人数
toolUseNum:使用人数
toolPrice:工具价格
toolState:工具状态
toolTag:工具标签
toolType:工具分类 见表2:工具分类
remark:备注
field1:备用字段


1_2. 获取工具详情

接口说明:本接口用于根据工具编号获取工具的详情;

接口地址: /survery/getToolDetail.htm
请求方法: post
Auth-date:[add by Sanjy]

请求格式:

params = { "toolNo": "A0013CM02-GE010", "sysParam": {} }

params: 必填 接口入口参数

toolNo: 必填 工具编号,由1_1(工具列表)接口获取提供;
sysParam: 系统参数,参考0_1中示例

返回格式:

json { "code": "200", "message": "Success.", "data": { "id": "eedabad1-0eb0-11e7-a2d0-02004c4f4f50", "toolNo": "A0046HR01-PE010", "createTime": "1490153965000", "detailMaxUrlApp": "http://server.cepingjia.net/XXX.jpg", "detailMaxUrlPc": "http://server.cepingjia.net/XXX.jpg", "toolAnswerTime": "10", "toolContent": "美国风行的“一分钟道歉法——...", "toolKeyword": "道歉 性格 OMA", "toolLabel": "1", "toolName": "OMA指数性格测评", "toolSysPrice": "0", "toolPushContent": "", "toolSurveyLimit": "1", "toolsSide": { "toolBrief": "美国风行的“一分钟道歉法——...", "answerBrief": "1. 共10题。\n2. 需在截止时间前完成任务,到期自动截止。", "updateTime": "1491975640000", "reportStyle": "single", "shortContext": "道歉风格窥见性格", "toolTag": "| 性格测试 | 沟通风格 | 性格|特质 |", "toolType": "school", "toolPrice": "0.00", "toolImgUrl": "" } } }

code:返回码, 200为正常,其他均为异常
message:对应code解释
data:工具的具体详情

id:工具ID,即toolId
toolNo:工具编号
createTime: 工具创建时间戳
detailMaxUrlApp:测评家系统中图片,用于移动端
detailMaxUrlPc:测评家系统中图片,用于PC网页
toolAnswerTime:工具答题时间限制
toolContent:测评家系统中,工具简介
toolKeyword:工具关键词
toolLabel:工具类型 1.代表个人工具,2.代表企业工具。系统使用,可忽略
toolName:工具名称
toolSysPrice:测评家系统中,工具价格
toolPushContent:工具简介,用于活动推送
toolSurveyLimit:工具答题人限制 若为1,人员无限制

toolsSide:工具额外信息,接入方配置信息

toolBrief:接入方配置中,工具简介
answerBrief:答题说明
reportStyle:报告方式 见表1:报告方式
shortContext: 工具一句话概括
toolTag: 工具标签
toolType: 工具分类 见表2:工具分类
toolImgUrl:工具图片
toolPrice:工具价格
updateTime:最近更新时间戳


测评接口

说明: 本类型接口,相对于接入方,分个人用户发起测评,和合作企业的用户发起测评,由bCompany来区分,默认值为0,表示为接入方的个人用户发起测评;若是合作企业的用户发起测评,需传值1,并附带company信息,详见下列接口。

2_1 发起测评

接口说明:本接口用于用户(bCompany为0代表接入方的个人用户,1代表接入方合作企业的用户)发起测评任务

接口地址: /task/startTask.htm
请求方法: post
Auth-date:[add by Sanjy]

请求格式:

params = { "toolNo": "A0056HR01-PE010", "sysParam": {}, "remark": "test", "taskPrice": "1.00", "taskObjectRemark":"新同事", "bCompany":1, "company": { "customeUtel": "132XXXX1100", "customeUid": "b1ccXXXX-XXXX-11e7-b7ca-408d5cc3e2a3", "customeCid": "b1d1XXXX-XXXX-11e7-b7ca-408d5cc3e2a3" }, "userInfor": [ { "userIndefy": "tttttttttttttttttttttt", "userName": "simaguang", "remark": "这是测试人员1" } ] }

params: 必填 接口入口参数

toolNo: 必填 工具编号,由1_1(工具列表)中接口获取提供
sysParam: 系统参数,参考0_1中示例
remark: 选填,测评任务备注
taskPrice: 必填 本次任务费用
taskObjectRemark:选填,任务答题者备注。用于任务区分

bCompany:若为合作企业的用户发起测评,传值1,否则,传0
company:企业信息,若bCompany为1,则此值必填;若bCompany为0,则此值可不传

customeUtel:必填 企业注册人手机账号
customeUid:必填 企业注册人id
customeCid:必填 入驻企业id

userInfor: 必填,JSONArry 每一项代表一位答题人

userIndefy:必填 答题人唯一标识,建议使用手机号码,长度8~48
userName:必填 答题人名称 长度1~48
remark:选填,答题人备注,或分组。

返回格式:

json { "code": "200", "message": "请求成功", "data": { "taskId": "d02ca363-a4ba-11e7-b7ca-408d5cc3e2a3", "toolId": "04a7a4e7-4b49-11e7-a2d0-02004c4f4f50", "transactionId": "d0488392-a4ba-11e7-b7ca-408d5cc3e2a3" } }

code:返回码, 200为正常,其他均为异常
message:对应code解释
data: 企业的基本信息

taskId:任务发起成功后的任务ID,用于后续答题。
toolId:任务发起成功后的工具ID,用于后续答题。
transactionId:本次测评交易记录id


2_2. 用户是否做过某工具测评

接口说明:本接口返回用户(bCompany为0代表接入方的个人用户,1代表接入方合作企业的用户)所参与某工具的所有测评,可用于检查用户是否已经做过某工具的测评。

接口地址: /task/getUserTasksByTool.htm
请求方法: post
Auth-date:[add by Sanjy]

请求格式:

params= { "toolId": "04a7XXXX-XXXX-11e7-a2d0-02004c4f4f50", "sysParam":{}, "bCompany":1, "company": { "customeUtel": "132XXXX1100", "customeUid": "b1ccXXXX-XXXX-11e7-b7ca-408d5cc3e2a3", "customeCid": "b1d1XXXX-XXXX-11e7-b7ca-408d5cc3e2a3" }, "userIndefy": "tttttttttttttttttttttt" }

params: 必填 接口入口参数

sysParam: 系统参数,参考0_1中示例;
toolId: 必填 工具ID,可由1_2(工具详情)接口获取;
userIndefy: 必填 用户标识;

bCompany:若为合作企业的用户发起测评,传值1,否则,传0
company:企业信息,若bCompany为1,则此值必填;若bCompany为0,则此值可不传

customeUtel:必填 企业注册人手机账号
customeUid:必填 企业注册人id
customeCid:必填 入驻企业id

返回格式:

{ "code": "200", "data": [ { "childTaskId": "ace9XXXX-XXXX-11e7-b7ca-408d5cc3e2a3", "reportId": "afe7XXXX-XXXX-11e7-b7ca-408d5cc3e2a3", "taskId": "ace9XXXX-XXXX-11e7-b7ca-408d5cc3e2a3", "tel": "tttttttttttttttttttttt", "toolId": "04a7XXXX-XXXX-11e7-a2d0-02004c4f4f50" } ], "message": "Success." }

code:返回码, 200为正常,其他均为异常
message:对应code解释
data:数据详情 JSONArray 每一项代表一次任务。

taskId:任务主ID
reportId:报告ID,若本次任务收到有效的答案提交,则会产生报告。
childTaskId:子任务ID
tel:用户标识,等同于userIndefy
toolId:工具ID


2_3. 查询所有用户的报告列表

接口说明:本接口用于企业(bCompany为0代表接入方,1代表接入方合作企业)查询所有的测评报告;分页查询

接口地址: /task/openGetAllReportList.htm
请求方法: post
Auth-date:[add by Sanjy]

请求格式:

params = { "pageNum": 1, "numOfPage": 10, "sysParam": {}, "bCompany":1, "company": { "customeUtel": "132XXXX1100", "customeUid": "b1ccXXXX-XXXX-11e7-b7ca-408d5cc3e2a3", "customeCid": "b1d1XXXX-XXXX-11e7-b7ca-408d5cc3e2a3" }, }

params: 必填 接口入口参数

pageNum: 必填 当前查询页,从1开始
numOfPage: 必填 每页条数
sysParam: 系统参数,参考0_1中示例

bCompany:若为合作企业的用户发起测评,传值1,否则,传0
company:企业信息,若bCompany为1,则此值必填;若bCompany为0,则此值可不传

customeUtel:必填 企业注册人手机账号
customeUid:必填 企业注册人id
customeCid:必填 入驻企业id

返回格式:

{ "code": "200", "data": { "beginPageIndex": 1, "currentPage": 1, "endPageIndex": 1, "numPerPage": 10, "pageCount": 1, "recordList": [ { "reportId": "f88dXXXX-XXXX-11e7-b7ca-408d5cc3e2a3", "toolId": "04a7XXXX-XXXX-11e7-a2d0-02004c4f4f50", "rptUserId": "4191XXXX-XXXX-11e7-a2d0-02004c4f4f50", "taskId": "f4b3XXXX-XXXX-11e7-b7ca-408d5cc3e2a3", "toolName": "MBTI职业性格测评(插图版)", "rptState": 1, "rptImg": "http://www", "userName": "XXX", "taskObjectRemark": "", "rptTime": 1506766023000, "taskTime": 1506766132000, } ], "totalCount": 1 }, "message": "Success." }

code:返回码, 200为正常,其他均为异常
message:对应code解释
data: 数据

beginPageIndex:起始页
currentPage: 当前页
endPageIndex:结束页
numPerPage:每页设置条数
totalCount:总条数
recordList:JSONArray,每一项代表一份报告

reportId:报告ID
toolId:工具ID
rptUserId:任务发起者ID
taskId:任务ID
toolName:工具名称
rptState:报告状态,1代表已查看,0代表未查看
rptImg:工具的图片地址
userName:发起者名称
taskObjectRemark:任务答题者备注
rptTime:报告产生时间
taskTime:任务时间


2_4. 查询用户的测评任务列表

接口说明:本接口用于用户(bCompany为0代表接入方的个人用户,1代表接入方合作企业的用户)查询测评任务列表。

接口地址: /task/openGetTaskList.htm
请求方法: post
Auth-date:[add by Sanjy]

请求格式:

params = { "sysParam": {}, "bCompany":1, "company": { "customeUtel": "132XXXX1100", "customeUid": "b1ccXXXX-XXXX-11e7-b7ca-408d5cc3e2a3", "customeCid": "b1d1XXXX-XXXX-11e7-b7ca-408d5cc3e2a3" }, "userInfor": { "userIndefy": "tttttttttttttttttttttt", "userName": "simaguangguang", "remark": "这是测试人员" } }

params: 必填 接口入口参数

userInfor: 必填 答题人信息;
sysParam: 系统参数,参考0_1中示例;

bCompany:若为合作企业的用户发起测评,传值1,否则,传0
company:企业信息,若bCompany为1,则此值必填;若bCompany为0,则此值可不传

customeUtel:必填 企业注册人手机账号
customeUid:必填 企业注册人id
customeCid:必填 入驻企业id

返回格式:

json { "code": "200", "data": [ { "taskId": "025ed318-a4ee-11e7-b7ca-408d5cc3e2a3", "taskReportId": "0f73d425-a4ee-11e7-b7ca-408d5cc3e2a3", "taskToolId": "04a7a4e7-4b49-11e7-a2d0-02004c4f4f50", "taskUserId": "41915c0b-2af8-11e7-a2d0-02004c4f4f50", "taskCompName": "司兄注册未认证", "taskName": "MBTI职业性格测评(插图版)", "taskObjectRemark": "", "taskRemark": "test", "taskState": 2, "taskType": 1, "toolImgUrl": "", "createTime": 1506672836000, "taskBeginTime": 1506672955000, "taskEndTime": 1507277755000, "updateTime": 1506672858000, } ], "message": "Success." }

code:返回码, 200为正常,其他均为异常
message:对应code解释
data: 即为任务列表,JSONArray,每一项代表一次任务。

taskId:本次任务ID
taskReportId:本次任务的对应的报告ID
taskToolId:本次任务对应的工具ID
taskName:任务名称
taskCompName:公司名称
taskObjectRemark:任务的答题者对象备注
taskRemark:任务备注
taskState:任务状态,见表3。
taskType:任务类型,系统备用
toolImgUrl:工具的图片地址
createTime:任务创建时间
taskBeginTime:任务起始时间
taskEndTime:任务结束时间
updateTime:更新时间,可以作为答题时间


2_5. 查询用户的历史报告列表

接口说明:本接口用于用户(bCompany为0代表接入方的个人用户,1代表接入方合作企业的用户)查询历史报告列表;

接口地址: /task/openGetReportList.htm
请求方法: post
Auth-date:[add by Sanjy]

请求格式:

params = { "sysParam": {}, "bCompany":1, "company": { "customeUtel": "132XXXX1100", "customeUid": "b1ccXXXX-XXXX-11e7-b7ca-408d5cc3e2a3", "customeCid": "b1d1XXXX-XXXX-11e7-b7ca-408d5cc3e2a3" }, "userInfor": { "userIndefy": "tttttttttttttttttttttt", "userName": "simaguangguang", "remark": "这是测试人员" } }

params: 必填 接口入口参数

userInfor: 必填 答题人信息;
sysParam: 系统参数,参考0_1中示例;

bCompany:若为合作企业的用户发起测评,传值1,否则,传0
company:企业信息,若bCompany为1,则此值必填;若bCompany为0,则此值可不传

customeUtel:必填 企业注册人手机账号
customeUid:必填 企业注册人id
customeCid:必填 入驻企业id

返回格式:

json { "code": "200", "data": [ { "reportType": "", "rptId": "", "rptImg": "http://server.cepingjia.net/imgServer/product/201703/1490266376920.jpg", "taskId": "", "taskNo": "", "toolLabel": 1, "toolName": "", "userName": "" } ], "message": "Success." }

code:返回码, 200为正常,其他均为异常
message:对应code解释
data: 即为报告列表,JSONArray,每一项代表一次报告。

reportType:报告类型
toolLabel:工具类型 1 个人,2 企业
toolName:工具名称
userName:测评家系统数据,sysParam中uid对应的名称
rptId:报告ID
taskId:任务ID
rptImg:工具图片


答题接口

3_1. 使用默认页面-开始答题

接口说明: 本接口用于开始答题,返回的是答题页面地址,接入方直接加载此链接,用户在本页面完成答题,提交答案,查看报告流程。若需要数据对接,请查看回调接口说明文档。

接口地址: /answer/beginAnswer.htm
请求方法: get
Auth-date:[add by Sanjy]

请求格式:

params = { "toolId":"007035f1-XXXX-XXXX-9ca9-408d5cc3e2a3", "taskId":"214d35df-XXXX-XXXX-9e55-408d5cc3e2a3", "sysParam":{}, "userInfor":{ "userIndefy":"1866XXXXXXX", "userName":"simaguangguang", "remark":"这是测试人员"} }

params: 必填 接口入口参数

toolId: 必填 工具ID;
taskId: 必填 任务ID;
sysParam: 系统参数,参考0_1中示例
userInfor: 必填 答题人信息;

userIndefy:必填 答题人唯一标识,建议使用手机号码,长度8~48
userName:必填 答题人名称
remark:选填,答题人备注,或分组。

返回:

若校验成功,则进入答题页
若校验失败,进入提示页


3_2. 自定义答题页面-获取答题题目

接口说明:本接口用于获取任务题目。若接入方希望自定义答题页面,则可以使用本接口获取到对应工具的题目。

接口地址: /answer/openGetToolSubjects.htm
请求方法: post
Auth-date:[add by Sanjy]

请求格式:

params = { "toolId":"007035f1-XXXX-XXXX-9ca9-408d5cc3e2a3", "taskId":"214d35df-XXXX-XXXX-9e55-408d5cc3e2a3", "sysParam":{}, "userInfor":{ "userIndefy":"1866XXXXXXX", "userName":"simaguangguang", "remark":"这是测试人员"} }

params: 必填 接口入口参数

toolId: 必填 工具ID;
taskId: 必填 任务ID;
sysParam: 系统参数,参考0_1中示例
userIndefy:必填 答题人唯一标识,建议使用手机号码,长度8~48
userName:必填 答题人名称 remark:选填,答题人备注,或分组。

返回格式:

json { "code": "200", "data": { "subjectList": { "data": [ { "id": "bfb5c360-4b4f-11e7-a2d0-02004c4f4f50", "optArray": [ { "optContent": "热情和敏感", "optImages": "http://server.cepingjia.net/xxx.gif", "optNo": "A0056HR01-PE010-T001-X1", "optRemark": "" }, { "optContent": "逻辑和明确", "optImages": "http://server.cepingjia.net/xxx.gif", "optNo": "A0056HR01-PE010-T001-X2", "optRemark": "" } ], "rlibContent": "认识你的人倾向形容你为:", "rlibNo": "A0056HR01-PE010-T001", "rlibRemark": "" } ] }, "questionType": 1, "taskCategory": "NQ", "taskId": "b9e4XXXX-XXXX-11e7-b7ca-408d5cc3e2a3", "taskName": "MBTI职业性格测评(插图版)", "taskType": "1", "toolId": "04a7XXXX-XXXX-11e7-a2d0-02004c4f4f50", "uid": "4191XXXX-XXXX-11e7-a2d0-02004c4f4f50", "userIndefy": "tttttttttttttttttttttt" }, "message": "请求成功" }

code:返回码, 200为正常,其他均为异常
message:对应code解释
data: 数据

questionType:1 ,带图答题; 其他为常规答题页
userIndefy: 答题人标识对应;
toolId: 工具ID,后续使用;
taskId: 任务ID,后续使用; taskName:任务名称;
uid:任务发起者ID;
taskType:系统使用 任务类型
taskCategory:系统使用 任务分类

subjectList:为题目信息,封装在data(JSONArray)内,每一项代表一题目

id:题目ID 提交答案时使用;
rlibContent:题目内容 rlibNo:题目编号
rlibRemark:题目备注

optArray:JSONArray,答案选项

optNo:选项编号,提交答案使用
optRemark: 选项备注
optContent:选项内容
optImages:选项图片,当questionType为1时,才会有此数据;


3_3. 自定义答题页面-提交答案

接口说明:本接口用于提交答案;

接口地址: /answer/openCommitSubject.htm
请求方法: post Auth-date:[add by Sanjy]

请求格式:

params = { "answers": { "toolId": "eedaXXXX-XXXX-11e7-a2d0-02004c4f4f50", "taskId": "0ae6XXXX-XXXX-11e7-a2d0-02004c4f4f50", "uid": "2b56XXXX-XXXX-11e6-927f-02004c4f4f50", "tel": "tttttttttttttttttttttt", "answerTime": 0, "rlibsList": [ { "rlibId": "629d5653-0eb1-11e7-a2d0-02004c4f4f50", "optId": "A0046HR01-PE010-T001-X3" }, { "rlibId": "6bf5782c-0eb3-11e7-a2d0-02004c4f4f50", "optId": "A0046HR01-PE010-T010-X4" } ] }, "sysParam": {} }

params: 必填 接口入口参数

answers: 必填 答案内容

tel: 必填答题人标识 userIndefy
uid: 必填 任务发起者uid,由2_1中接口获取提供;
taskId: 必填 任务ID,由2_1中接口获取提供;
toolId: 必填 工具ID,由2_1中接口获取提供;
answerTime:必填 答题所用时间,分钟取整;
rlibsList:必填 所选答案列表,参考DEMO

rlibId:题目ID,对应题目ID
optId:所选答案ID,对应选项编号

sysParam: 系统参数,参考0_1中示例

返回格式:

json { code: "200", message: "Success." }


3_4. 自定义答题页面-查询报告是否生成

接口说明:本接口查询报告是否生成;

接口地址: /answer/openQueryReport.htm
请求方法: post Auth-date:[add by Sanjy]

请求格式:

params = { "taskId": "0ae6XXXX-XXXX-11e7-a2d0-02004c4f4f50", "sysParam": {}, "userInfor": { "userIndefy": "tttttttttttttttttttttt", "userName": "simaguangguang", "remark": "这是测试人员" } }

params: 必填 接口入口参数

taskId: 必填 任务ID; userInfor: 必填 答题人信息;
sysParam: 系统参数,参考0_1中示例;

返回格式:

json { code: "200", data:"XXXXXXXXXXXXXXXXXX",message: "Success." }

data: 即为返回的reportID,用于查询报告详情;


3_5. 自定义答题页面-查询报告详情

接口说明:本接口用于查询报告详情,返回报告详情的URL;

接口地址: /answer/openGetReportDetail.htm
请求方法: post Auth-date:[add by Sanjy]

请求格式:

params = { "reportId": "fd45XXXX-XXXX-11e7-a2d0-02004c4f4f50", "sysParam": {}, "taskId": "0ae63XXX-XXXX-11e7-a2d0-02004c4f4f50" }

params: 必填 接口入口参数

taskId: 必填 任务ID;
reportId: 必填 报告ID,可以由3_4中接口获取;
sysParam: 系统参数,参考0_1中示例;

返回格式:

json { code: "200", data: "http://www.cepingjia.net/EvaluationHome/support/XX6e1c5-XXXX-11e6-927f-02004c4f4f50APP", message: "请求成功" }

data: 即为返回的报告URL,用于查询报告详情;



回调接口

1. 用户已答题状态回调

回调说明:当用户已经提交了测评答题,则返回此状态;

传入参数格式:

params={ "backType":"1", "backInfor":{ "taskId":"1866XXXXXXX", "userIndefy":"simaguangguang", "state":"1", "message":"答题提交成功" } }

backType: 消息类型,1 代表答题状态
backInfor: 返回信息

taskId: 任务ID;
state: 提交状态,1成功。
userIndefy:答题人员标识
message:状态信息


2. 用户已查看报告状态回调

回调说明:当用户已经查看了报告,则返回此状态;

传入参数格式:

params={ "backType":"2", "backInfor":{ "taskId":"1866XXXXXXX", "reportId":"XXXXXXXX", "userIndefy":"simaguangguang", "state":"1", "message":"用户已查看报告" } }

backType: 消息类型,2 代已查看报告
backInfor: 返回信息

taskId: 任务ID;
reportId: 报告ID;
state: 提交状态,1成功。
userIndefy:答题人员标识
message:状态信息


名词解释

词语 标识 说明
接入方 在测评家的账户系统内申请接入账号并获得授权的企业
合作企业 在接入方的账户系统内,与接入方达成合作的企业
工具编号 toolNo 由接口1_1查询工具列表中提供,每个工具对应的编号,唯一并确保数据不变。
工具ID toolId 由接口1_2查询工具详情提供,和工具编号一一对应,唯一但不确保数据不变。
任务ID taskId 发起任务时所生成的ID,是每个测评任务的唯一标识。每个工具ID可对应多个任务ID,每个任务对应一个报告ID。
报告ID reportId 任务完成并生成报告后产生的ID,是报告的唯一标识,每个任务ID,对应一个报告ID。可由接口2_3来获取。

附表格

表1. 报告方式

说明:报告类型,默认为单人测评。用于当发起多人测评任务时,根据工具的类型,产生报告的方式不一样。

reportStyle 报告类型 说明
single 单人测评 相对于同一个任务,每位答题者,得到一份报告
whole 团体测评 相对于同一个任务,只产生一份报告

表2. 任务状态

说明:任务的分类

taskState 任务状态
1 未完成
2 已完成
3 已截止
4 已作废
敬请期待
敬请期待
0755-86520995