通过输入名称以及班级奖项进行生成奖状。
| 参数名 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| key | string | 是 | 接口调用密钥 | |
| name | string | 否 | 名字 | 张三 |
| title | string | 否 | 需要生成的奖项标题 | 三好少妇 |
| classname | string | 否 | 需要生成的班级 | 少妇学院少妇一班 |
[
{
"name": "key",
"type": "string",
"required": true,
"description": "接口调用密钥",
"example": ""
},
{
"name": "name",
"type": "string",
"required": false,
"description": "名字",
"example": "张三"
},
{
"name": "title",
"type": "string",
"required": false,
"description": "需要生成的奖项标题",
"example": "三好少妇"
},
{
"name": "classname",
"type": "string",
"required": false,
"description": "需要生成的班级",
"example": "少妇学院少妇一班"
}
]
{
"openapi": "3.1.1",
"info": {
"title": "奖状生成器",
"description": "通过输入名称以及班级奖项进行生成奖状。",
"version": "1.0.0"
},
"paths": {
"/api/bqbjk/jzszc/api.php": {
"get": {
"summary": "奖状生成器",
"description": "通过输入名称以及班级奖项进行生成奖状。",
"parameters": [
{
"name": "key",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "接口调用密钥"
},
{
"name": "name",
"in": "query",
"required": false,
"schema": {
"type": "string",
"example": "张三"
},
"description": "名字"
},
{
"name": "title",
"in": "query",
"required": false,
"schema": {
"type": "string",
"example": "三好少妇"
},
"description": "需要生成的奖项标题"
},
{
"name": "classname",
"in": "query",
"required": false,
"schema": {
"type": "string",
"example": "少妇学院少妇一班"
},
"description": "需要生成的班级"
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"post": {
"summary": "奖状生成器",
"description": "通过输入名称以及班级奖项进行生成奖状。",
"parameters": [
{
"name": "key",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "接口调用密钥"
},
{
"name": "name",
"in": "query",
"required": false,
"schema": {
"type": "string",
"example": "张三"
},
"description": "名字"
},
{
"name": "title",
"in": "query",
"required": false,
"schema": {
"type": "string",
"example": "三好少妇"
},
"description": "需要生成的奖项标题"
},
{
"name": "classname",
"in": "query",
"required": false,
"schema": {
"type": "string",
"example": "少妇学院少妇一班"
},
"description": "需要生成的班级"
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
}
}
},
"servers": [
{
"url": "https://api.317ak.com",
"description": "当前访问入口(https)"
}
]
}
用于根据输入的名称、班级及奖项信息生成对应奖状内容。适用于需要快速制作个性化奖状的场景。
https://api-v2.317ak.com/api/bqbjk/jzszc/api.php
支持 GET、POST 请求方式。
接口调用需要进行鉴权,请在请求参数中通过 Query 方式传递调用密钥:
key=接口调用密钥
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| key | string | 是 | 接口调用密钥 |
| name | string | 否 | 名字,例如:张三 |
| title | string | 否 | 需要生成的奖项标题,例如:三好学生 |
| classname | string | 否 | 需要生成的班级,例如:某某学院某某班 |
成功生成奖状后,接口返回生成结果数据。由于该接口暂无固定返回示例,实际响应内容以接口实时返回为准。
| 字段 | 类型 | 说明 |
|---|---|---|
| 暂无固定字段 | - | 当前资料未提供成功响应字段定义,具体返回字段以接口实际响应内容为准。 |
{"code":0,"msg":"未提供调用密钥","errcode":11001}
| errcode | 含义 |
|---|---|
| 11001 | 未提供调用密钥 |
| 11002 | 密钥错误 |
| 11003 | 密钥已禁用 |
| 11004 | 积分余额不足 |
| 11005 | 请求过于频繁(QPM 限制) |
| 11006 | 接口维护中 |
| 11007 | 接口已禁用 |
| 11008 | 接口不可用 |
| 11009 | 密钥校验暂不可用 |
| 11010 | 积分系统暂不可用 |
| 11011 | 收费接口须提供有效密钥 |
| 11012 | 鉴权方式错误 |
| 11013 | 接口不存在 |
| 11014 | 请求目标地址无效 |
| 11015 | 请求目标地址不允许 |
| 11016 | 请求目标服务失败 |
| 11017 | 服务暂不可用 |
| 11018 | 请求方式不允许 |
| 11019 | 当前IP不在白名单内 |
| 11020 | 启用出口转发功能须提供有效密钥 |
| 11021 | 未配置可用出口转发服务 |
| 11022 | 出口转发服务不可用 |
| 11023 | 密钥已过期 |
| 11024 | 令牌分配积分不足 |
curl -G "https://api-v2.317ak.com/api/bqbjk/jzszc/api.php" \
--data-urlencode "key=你的接口密钥" \
--data-urlencode "name=张三" \
--data-urlencode "title=三好学生" \
--data-urlencode "classname=一年级一班"
## 注意事项
- 调用接口前需准备有效调用密钥,并妥善保管,避免将密钥公开发布或直接暴露在客户端代码中。
- 接口请求建议使用 HTTPS 进行传输,以降低请求数据在传输过程中的泄露风险。
- 请求时请确保 `name`、`title`、`classname` 参数内容符合生成需求;未填写可选参数时,将根据接口实际处理规则生成结果。
- `title` 用于设置奖项标题,`classname` 用于设置班级信息,请注意参数长度及内容格式,避免因特殊字符导致生成异常。
- 请合理控制调用频率,避免短时间内大量重复请求影响接口正常使用。
- 接口为免费调用服务,使用时仍应遵守合理调用规范,不得进行恶意刷取或影响其他用户正常使用的行为。# 奖状生成器调用
# GET查询参数鉴权
curl -G "https://api-v2.317ak.com/api/bqbjk/jzszc/api.php" \
--data-urlencode "key=YOUR_API_KEY" \
--data-urlencode "name=张三" \
--data-urlencode "title=三好学生" \
--data-urlencode "classname=一班" \
--data-urlencode "title=三好学生"