问卷星开放文档

问卷星开放文档


单点注册/登录(SSO)用户体系

<p>[TOC]</p> <h1>接口介绍</h1> <p>使用该接口,可以通过SSO(单点登录)的方式让参与者登录到您创建的用户体系中。适用的场景为:您针对参与者已经有了一套用户系统,但是需要使用问卷星用户体系进行考试、问卷的集中发放,使用该接口后参与者只需要登录您原有的系统,就可以使用一个按钮无缝转移到问卷星的用户体系中。</p> <h1>接口说明</h1> <p>请求方式:<code>Get</code></p> <p>加密链接:<code>https://www.wjx.cn/user/loginform.aspx?u=&amp;userSystem=&amp;systemId=&amp;appid=&amp;uid=&amp;uname=&amp;udept=&amp;uextf=&amp;islogin=&amp;ts=&amp;sign=</code></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">参数说明</th> <th>是否必须</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">u</td> <td style="text-align: left;">您账户用户名,为固定值</td> <td>是</td> </tr> <tr> <td style="text-align: left;">userSystem</td> <td style="text-align: left;">用户体系的类型,为固定值 1</td> <td>是</td> </tr> <tr> <td style="text-align: left;">systemId</td> <td style="text-align: left;">用户体系的ID,为固定值</td> <td>是</td> </tr> <tr> <td style="text-align: left;">appid</td> <td style="text-align: left;">开发ID,可以在“API自动登录”弹框查询到</td> <td>是</td> </tr> <tr> <td style="text-align: left;">uid</td> <td style="text-align: left;">参与者ID,鉴别参与者唯一身份的ID</td> <td>是</td> </tr> <tr> <td style="text-align: left;">ts</td> <td style="text-align: left;">时间戳,从1970-01-01 00:00:00开始到现在的秒数,有效期为300秒</td> <td>是</td> </tr> <tr> <td style="text-align: left;">encode</td> <td style="text-align: left;">签名验证方式,目前支持sha1和sm3,不传或传入不合法时,默认使用:sha1</td> <td>否</td> </tr> <tr> <td style="text-align: left;">sign</td> <td style="text-align: left;">加密签名,算法sign=sha1(appid+appkey+uid+ts)当encode=sm3时,sign=sm3(appid+appkey+uid+ts)点击查看 <a href="https://www.wjx.cn/signsample.aspx?type=8" title="签名示例">签名示例</a></td> <td>是</td> </tr> <tr> <td style="text-align: left;">upass</td> <td style="text-align: left;">参与者初始登录密码,用于参与者手动登录(可使用比如用户ID或其后6位等规则),传递后会加密存储。用户体系需添加此字段,否则接口传入也会被舍弃</td> <td>否</td> </tr> <tr> <td style="text-align: left;">uname</td> <td style="text-align: left;">参与者姓名,用户体系需添加此字段,否则接口传入也会被舍弃</td> <td>否</td> </tr> <tr> <td style="text-align: left;">udept</td> <td style="text-align: left;">参与者部门,用户体系需添加此字段,否则接口传入也会被舍弃</td> <td>否</td> </tr> <tr> <td style="text-align: left;">uextf</td> <td style="text-align: left;">参与者附加信息,用户体系需添加此字段,否则接口传入也会被舍弃</td> <td>否</td> </tr> <tr> <td style="text-align: left;">islogin</td> <td style="text-align: left;">当用户体系中无此参与者时,是否允许自动注册:1为允许,0为不允许,默认为1</td> <td>否</td> </tr> <tr> <td style="text-align: left;">activity</td> <td style="text-align: left;">需要跳转的问卷编号,跳转的问卷需要已经绑定给了此参与者</td> <td>否</td> </tr> <tr> <td style="text-align: left;">sojumpparm</td> <td style="text-align: left;">自定义链接参数,支持在答卷来源中记录,跳转时{output}中回传</td> <td>否</td> </tr> <tr> <td style="text-align: left;">r</td> <td style="text-align: left;">当且仅当activity有值时有效,r = &quot;1&quot; 表示跳转到activity对应问卷的结果查询页</td> <td>否</td> </tr> <tr> <td style="text-align: left;">returnurl</td> <td style="text-align: left;">指定登录成功后的跳转地址</td> <td>否</td> </tr> <tr> <td style="text-align: left;">pagetype</td> <td style="text-align: left;">跳转地址类型:默认为待参与列表时可以不带此参数0: 待参与列表 1:已参与列表 2: 积分排行<br>注:当且仅当returnurl参数不为空时有效</td> <td>否</td> </tr> </tbody> </table> <p>以上参数中: <code>u\userSystem\systemId</code> 在同一个用户体系中均为固定值,在“API自动登录”弹窗的接口链接中可以直接复制获取; <code>appid</code>和<code>appkey</code>也可以直接在“API自动登录”弹窗中获取到;</p> <p><code>uid\uname\udept\uextf\islogin\ts\sign</code>为变量,需要用户根据实际情况传入;</p> <p>注意:传递的参数值前后任意形式的空格均会被过滤。</p> <h1>使用步骤</h1> <p>1、登录问卷星后台创建一个用户体系(不能使用微信服务号和企业微信的方式创建); 2、用户体系的字段可以自由设置,“用户ID”为必须字段,需注意“”添加的字段和随后传入的字段需保持一致; 3、开发接口,让参与者自动进行登录。</p> <p>如果需要通过接口批量注册用户体系的参与者,或者说一键同步您系统中通讯录到用户体系中,请参考此开发文档:用户体系参与者批量注册API接口</p>

页面列表

ITEM_HTML