开发者中心
申请新应用
| 应用 | AppKey | AppSecret | QPS | 日限额 | 状态 | 操作 |
|---|---|---|---|---|---|---|
| {{ a.app_name }} | {{ a.app_key }} |
{{ a.app_secret ? a.app_secret : '—(未通过审核)' }} |
{{ a.qps_limit }} | {{ a.daily_limit }} | {{ statusText(a.status) }} |
|
| 暂无应用,提交申请后由管理员审核 | ||||||
调用日志(最近 100 条)
| 时间 | 方法 | 接口 | 状态码 | IP |
|---|---|---|---|---|
| {{ l.created_at }} | {{ l.method }} | {{ l.endpoint }} | {{ l.response_code }} | {{ l.ip_address }} |
配置 Webhook
第三方往生成的链接 POST 数据即可回传,无需填写地址
Webhook #{{ w.id }}
{{ w.mode==='inbound' ? '接收' : '推送' }}
· {{ w.url }}
接收链接
第三方通过 POST 向此链接发送 JSON 数据,数据将自动解析并保存为问卷答卷(可在统计页查看),同时记录在推送日志中。
回调数据格式(结合问卷「{{ w.survey.title }}」共 {{ w.survey.questions.length }} 题)
{{ w.callbackExample }}
answers[].question_ukey 对应各题目,value 为答案值。提交后可在问卷统计页查看该答卷。
平台推送数据格式(触发:新答卷 / {{ w.survey ? w.survey.title : '' }})
{{ w.pushExample }}
| 时间 | 答卷 | 状态 | 响应码 | 重试 | 错误信息 | 操作 |
|---|---|---|---|---|---|---|
| {{ l.sent_at }} | {{ l.response_id }} | {{ l.status }} | {{ l.response_code || '-' }} | {{ l.retry_count }} | {{ l.error_message || '-' }} | |
| 暂无推送记录 | ||||||
签名认证说明
所有 API 请求需携带以下请求头进行 HMAC-SHA256 签名认证:
| 请求头 | 说明 | 示例 |
|---|---|---|
X-App-Key | 应用密钥(审核通过后获得) | abc123def456 |
X-Timestamp | Unix 时间戳(秒),与服务器差 ≤5 分钟 | 1724500000 |
X-Nonce | 随机字符串(每次请求不同) | a1b2c3d4e5f6 |
X-Sign | HMAC-SHA256 签名值 | 见下方算法 |
签名算法
message = HTTP方法 + "\n" + 请求路径 + "\n" + 时间戳 + "\n" + Nonce + "\n" + 请求体sign = HMAC-SHA256(AppSecret, message)
错误码
| 错误码 | 说明 |
|---|---|
4001 | 缺少签名参数 / 应用未审核通过 |
4002 | 时间戳过期或格式错误 |
4003 | 重复请求(Nonce 已使用) |
4004 | 签名校验失败 |
4290 | QPS 超限 |
4291 | 日调用量超限 |
接口列表
| 方法 | 路径 | 说明 | 认证 |
|---|---|---|---|
| POST | /api/v1/surveys | 创建问卷 | 签名 |
| GET | /api/v1/surveys | 查询问卷列表 | 签名 |
| PUT | /api/v1/surveys/{id} | 更新问卷 | 签名 |
| DELETE | /api/v1/surveys/{id} | 删除问卷 | 签名 |
| POST | /api/v1/surveys/{id}/publish | 发布问卷 | 签名 |
| POST | /api/v1/responses | 提交答卷 | 签名 |
| GET | /api/v1/responses/{id} | 查询答卷详情 | 签名 |
| GET | /api/v1/responses/export | 导出答卷 CSV | 签名 |
| POST | /api/v1/files/upload | 上传文件 | 签名 |
| POST | /api/v1/webhooks | 配置 Webhook | 签名 |
| GET | /api/v1/webhooks/{id}/logs | Webhook 日志 | 签名 |
签名示例
在线调试(Swagger UI)
正在加载 API 在线调试工具...
若长时间未加载,可查看上方完整的接口列表与签名规范