接口路径(新):http://hn.api.yesapi.net/api/App/Market_Questionnaire/GetQuestionnaireList
接口路径(旧):http://hn.api.yesapi.net/?s=App.Market_Questionnaire.GetQuestionnaireList
接口描述: 调查问卷-获取问题列表,使用前请先安装调查问卷插件
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| order | 整型 | 可选 | 1 | 1按配置顺序显示,2按配置时间逆序 | |
| page | 整型 | 可选 | 1 | 最小:1 | 第几页 |
| perpage | 整型 | 可选 | 10 | 最小:1;最大:100 | 分页数量 |
| questionnaire_type | 整型 | 必须 | 类型,可以根据类型不同配置不同调查问卷 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 7701 获取调查问卷问题列表】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_Questionnaire.GetQuestionnaireList`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 调查问卷-获取问题列表,使用前请先安装调查问卷插件
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_Questionnaire.GetQuestionnaireList` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中: 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。 静态签名,简单,固定的签名,点击获取。 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。 定制签名,支持个性化签名签名算法定制。 |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中: return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}; return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。 |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |
### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| order | int | 可选 | 1按配置顺序显示,2按配置时间逆序 |
| page | int | 可选 | 第几页 |
| perpage | int | 可选 | 分页数量 |
| questionnaire_type | int | 必填 | 类型,可以根据类型不同配置不同调查问卷 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景|
| data.err_msg | string | 错误提示信息,err_code非0时参考此提示信息|
| data.total | int | 问题总数|
| data.items | array | 问题列表|
| data.items[].id | int | 问题ID|
| data.items[].question | string | 问题|
| data.items[].answer | array | 答案选项|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_Questionnaire.GetQuestionnaireList&app_key=YOUR_APP_KEY" \
-H "Content-Type: application/json;charset=UTF-8" \
-d "YOUR_POST_DATA_JSON"
```
成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
"ret": 200,
"data": `成功返回的业务数据`,
"msg": ""
}
```
失败返回示例:
```json
{
"ret": 400,
"data": [],
"msg": "客户端非法请求:xxx参数错误"
}
```<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$rs = OkayApiClient::request('App.Market_Questionnaire.GetQuestionnaireList',array('questionnaire_type'=>1));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
[total] => 1
[items] => Array
(
[0] => Array
(
[id] => 2
[questionnaire_question] => 今年你最喜欢今年春晚的哪个节目?
[questionnaire_answer] => Array ( )
)
)
)
[msg] => 小白开放接口:App.Market_Questionnaire.GetQuestionnaireList
)
*/| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
| data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
| data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
| data.total | 整型 | 问题总数 |
| data.items | 字符串 | 问题列表 |
| data.items[].id | 整型 | 问题ID |
| data.items[].question | 字符串 | 问题 |
| data.items[].answer | 字符串 | 答案选项 |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://hn.api.yesapi.net/api/App/Market_Questionnaire/GetQuestionnaireResultList
接口路径(旧):http://hn.api.yesapi.net/?s=App.Market_Questionnaire.GetQuestionnaireResultList
接口描述: 调查问卷-获取结果列表,使用前请先安装调查问卷插件
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| order | 整型 | 可选 | 1 | 1按回答时间顺序显示,2按回答时间逆序 | |
| page | 整型 | 可选 | 1 | 最小:1 | 第几页 |
| perpage | 整型 | 可选 | 10 | 最小:1;最大:100 | 分页数量 |
| questionnaire_type | 整型 | 必须 | 类型,可以根据类型不同配置不同调查问卷 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 7702 获取调查问卷答题结果列表(每张问卷一条数据)】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_Questionnaire.GetQuestionnaireResultList`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 调查问卷-获取结果列表,使用前请先安装调查问卷插件
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_Questionnaire.GetQuestionnaireResultList` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中: 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。 静态签名,简单,固定的签名,点击获取。 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。 定制签名,支持个性化签名签名算法定制。 |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中: return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}; return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。 |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |
### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| order | int | 可选 | 1按回答时间顺序显示,2按回答时间逆序 |
| page | int | 可选 | 第几页 |
| perpage | int | 可选 | 分页数量 |
| questionnaire_type | int | 必填 | 类型,可以根据类型不同配置不同调查问卷 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景|
| data.err_msg | string | 错误提示信息,err_code非0时参考此提示信息|
| data.total | int | 结果总数|
| data.items | array | 结果列表|
| data.items[].id | int | 结果ID|
| data.items[].questionnaire_result[].question | string | 问题|
| data.items[].questionnaire_result[].answer | string | 答案|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_Questionnaire.GetQuestionnaireResultList&app_key=YOUR_APP_KEY" \
-H "Content-Type: application/json;charset=UTF-8" \
-d "YOUR_POST_DATA_JSON"
```
成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
"ret": 200,
"data": `成功返回的业务数据`,
"msg": ""
}
```
失败返回示例:
```json
{
"ret": 400,
"data": [],
"msg": "客户端非法请求:xxx参数错误"
}
```<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$rs = OkayApiClient::request('App.Market_Questionnaire.GetQuestionnaireResultList',array('questionnaire_type'=>1));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
[total] => 2
[items] => Array
(
[0] => Array ( [id] => 3 [questionnaire_result] => )
[1] => Array ( [id] => 5 [questionnaire_result] => )
)
)
[msg] => 小白开放接口:App.Market_Questionnaire.GetQuestionnaireResultList )
*/
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
| data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
| data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
| data.total | 整型 | 结果总数 |
| data.items | 字符串 | 结果列表 |
| data.items[].id | 整型 | 结果ID |
| data.items[].questionnaire_result[].question | 字符串 | 问题 |
| data.items[].questionnaire_result[].answer | 字符串 | 答案 |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
接口路径(新):http://hn.api.yesapi.net/api/App/Market_Questionnaire/AnswerQuestionnaire
接口路径(旧):http://hn.api.yesapi.net/?s=App.Market_Questionnaire.AnswerQuestionnaire
接口描述: 收集调查问卷结果,使用前请先安装调查问卷插件
| 参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,点击查看,或免费注册。 | |
| sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
| uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
| token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
| return_data | 字符串 | 可选 | 公共参数 数据返回结构,其中:
| ||
| yesapi_allow_origin | 整型 | 可选 | 0 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 | |
| questionnaire_result | 字符串 | 必须 | 问卷结果,JSON的提交格式是:[{"question":"问题1","answer":"回答1"},{"question":"问题2","answer":"回答2"}] | ||
| questionnaire_type | 整型 | 必须 | 类型,可以根据类型不同配置不同调查问卷 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。
# 【 7703 收集调查问卷结果】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_Questionnaire.AnswerQuestionnaire`
**请求方式**: POST/GET
## 接口基本信息
- **功能描述**: 收集调查问卷结果,使用前请先安装调查问卷插件
- **返回格式**: JSON
## 请求参数说明
### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Market_Questionnaire.AnswerQuestionnaire` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中: 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。 静态签名,简单,固定的签名,点击获取。 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。 定制签名,支持个性化签名签名算法定制。 |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中: return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}; return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。 |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |
### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| questionnaire_result | array | 必填 | 问卷结果,JSON的提交格式是:[{"question":"问题1","answer":"回答1"},{"question":"问题2","answer":"回答2"}] |
| questionnaire_type | int | 必填 | 类型,可以根据类型不同配置不同调查问卷 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|--------|------|------|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.err_code | int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景|
| data.err_msg | string | 错误提示信息,err_code非0时参考此提示信息|
## 请求示例
```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_Questionnaire.AnswerQuestionnaire&app_key=YOUR_APP_KEY" \
-H "Content-Type: application/json;charset=UTF-8" \
-d "YOUR_POST_DATA_JSON"
```
成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
"ret": 200,
"data": `成功返回的业务数据`,
"msg": ""
}
```
失败返回示例:
```json
{
"ret": 400,
"data": [],
"msg": "客户端非法请求:xxx参数错误"
}
```| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
| data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
| data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
| _t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
| _auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单 |
由 果创云YesApi.cn 提供技术支持,4万+开发者都在用,累计API调用1,800,000+万次