问卷星开放文档

问卷星开放文档


自定义链接参数

<p>[TOC]</p> <h2>什么是自定义链接</h2> <p>自定义链接是指:可以在普通问卷链接的基础上添加参数,将参数值传递到问卷中,并存储为问卷的答卷数据。</p> <p>例如:您有自己的用户系统,在为用户配置问卷参与链接时,可以通过参数带入用户的各种信息,跟踪答题状态,回传作答状态及数据。</p> <h2>使用要求</h2> <p>免费版用户无法使用自定义链接的功能。企业版本可使用默认的「sojumpparm」参数,无法添加更多参数。尊享版及以上,不仅可以使用默认的「sojumpparm」参数,还可以添加更多的参数。</p> <h2>默认参数和添加题目参数</h2> <p><img src="https://www.showdoc.com.cn/server/api/attachment/visitFile?sign=ece4de7e7b2fe70f50e0f497eddc707a" alt="" /></p> <h3>1、默认参数</h3> <p>问卷星默认会提供一个「sojumpparm」参数,通过此参数传递进来的数据,会保存在答卷的「来源详情」的字段。该参数为:string类型(如果包含中文或特殊字符请使用UrlEncode编码)、最大长度为100个字符。</p> <h3>2、添加题目参数</h3> <p>如果需要传递更多的参数,可以在页面上点击「添加参数」,这里添加的参数必须是问卷中的「填空题」、「单选题」或「多级下拉题」,所以需要在设计问卷时添加好对应的问卷题目,如果不想让填写者看到这些题目,可以将这些题目设置为隐藏状态。</p> <p>题目参数传递进来的数据,会存储在对应的题目数据中,同填写者正常作答的数据一致。题目参数的类型依据对应的题目类型的不同而不同,如「填空题」为字符串类型,「单选题」「多级下拉题」为选择类型。</p> <h2>参数的代入</h2> <h3>1、开发组装链接参数</h3> <p>一般来说使用「开发组装链接参数」都需要贵方开发人员参与,依据本篇文档进行自定义链接参数的组装,带入贵方系统中的必要字段。需要注意的是:如果添加了多个参数,则只能通过「开发组装」的方式来使用「自定义链接」。</p> <h3>2、开发POST参数</h3> <p>「开发POST参数」也需要贵方开发人员参与,通过POST的方式,将参数带入。</p> <p>POST地址:问卷的通用地址,可以在「链接与二维码」页面获取;</p> <p>数据格式:x-www-form-urlencoded;</p> <p>参数带入:以键值对形式带入,参数名及参数值的计算同「链接传参」一致。</p> <p><img src="https://helpimage.paperol.cn/20220616175558.png" alt="" /></p> <p><img src="https://helpimage.paperol.cn/20220616180151.png" alt="" /></p> <h3>3、手动填入</h3> <p>如果只使用一个参数,则可以在问卷星后台手动批量生成带参数的链接。如果是「sojumpparm」默认参数和「字符串」的参数,可以批量上传一批参数值然后下载获取对应的链接与二维码。如果是「选择类」参数,则无需上传就可以直接批量导出带参数的链接与二维码。</p> <p><img src="https://helpimage.paperol.cn/20220411110543.png" alt="图片" /></p> <h2>关键参数</h2> <p>关键参数是用来控制「 每个关键参数值可作答次数」这个功能的,默认情况下是「sojumpparm」这个参数,添加多个参数后可以修改为其他的参数。</p> <p><img src="https://helpimage.paperol.cn/20220411110613.png" alt="图片" /></p> <h2>数据查询</h2> <p>传递参数时带入isquery参数就可以控制当前访问是「作答」还是「查询」,其中参数值为0时为作答问卷,参数值为1时为查询答卷。isquery参数可以为空,为空时默认为作答问卷,isquery参数也不参与parmsign参数的签名计算。</p> <h2>安全配置</h2> <p><img src="https://helpimage.paperol.cn/20220411110639.png" alt="图片" /></p> <p>1、「只允许从自定义链接访问」,勾选后只能通过自定义链接参数作答,普通问卷链接会提示无法访问。</p> <p>2、「增加过期时间」,勾选后生成的自定义链接参数会增加一个过期时间戳字段(endts),超过后链接将失效。</p> <p>3、「校验参数签名」,勾选后生成的自定义链接参数会增加一个签名字段(parmsign),如果有人篡改参数值,链接将失效。</p> <p>4、「提交后再次访问可查询作答记录」,勾选后用户在「没有达到访问次数」前可以正常访问作答,在「达到访问次数」后将直接进入答卷页面。需要注意的是:这里的设置效果同「 每个关键参数值可作答次数」有强关联。</p> <h2>DEMO</h2> <p>为了方便用户进行开发调试,增加的任何参数或设置,均可以在「链接参数URL预览」中体现,并且系统还提供了一个「DEMO」生成的功能,可以手动输入参数进行调用测试。</p> <p><img src="https://helpimage.paperol.cn/20220411110730.png" alt="图片" /> <img src="https://helpimage.paperol.cn/20220411110922.png" alt="图片" /></p> <h2>回传参数</h2> <p>带入的参数,如果想回调到自己系统,可以在「设计问卷」》「问卷设置」》「提交后显示」》「跳转到指定页面」中设置一个回调地址,并且按如下规则在回调地址中写入之前带入的参数。</p> <p><img src="https://helpimage.paperol.cn/20220411111037.png" alt="图片" /></p> <blockquote> <p>默认「sojumpparm」参数的回调写法{output},需特别注意「sojumpparm」的回调写法并非是{sojumpparm}。</p> <p>q1参数的回调写法为{q1},其他序号题目依次类推。</p> </blockquote> <h2>在问卷页面中显示带进来的参数</h2> <p>问卷页面支持将默认的「sojumpparm」参数显示在段落说明或题干中。插入方法:将[sojumpparm]这个字段输入在段落说明或题干中,如下图所示(显示带进来的参数仅限尊享版用户使用):</p> <p>示例:<a href="https://www.wjx.cn/jq/37943379.aspx?sojumpparm=张三">https://www.wjx.cn/jq/37943379.aspx?sojumpparm=张三</a></p> <p><img src="https://pubnew.paperol.cn/36306761/1555637509b5shrF.png" alt="图片" /></p> <p><a href="https://www.wjx.cn/Help/Help.aspx?helpid=620" title="自定义链接参数API_旧版文档">自定义链接参数API_旧版文档</a></p>

页面列表

ITEM_HTML