YesApi 接口文档

成语接龙接口

接口路径(新)：http://api.yesapi.net/api/App/Common_ChengYu/ChengYuJieLong

接口路径(旧)：http://api.yesapi.net/?s=App.Common_ChengYu.ChengYuJieLong

接口描述： 根据一个成语，返回接龙后的多个成语。随机返回最多10个成语，已收录30000+个成语，仅用于学习。

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • 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，欢迎使用小白开放接口！"}。
word字符串可选成语，如：光明正大，为空时随机返回开头的成语
match布尔型可选true是否精确匹配，false否时会返回同音字成语
top_num整型可选3最小：1；最大：30需要返回的成语数量

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例 
（第一次请求，随机成语）
{你的接口域名}/?s=App.Common_ChengYu.ChengYuJieLong

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "next_list": [
            {
                "word": "兔走鹘落",
                "pinyin": "tu zou gu luo"
            },
            {
                "word": "访亲问友",
                "pinyin": "fang qin wen you"
            },
            {
                "word": "我心如秤",
                "pinyin": "wo xin ru cheng"
            }
        ]
    },
    "msg": "",
    "_t": 1691647214,
    "_auth": "d4bc48c24de78c772261389edf3dc3ec"
}


（第二次请求，指定成语）
{你的接口域名}/?s=App.Common_ChengYu.ChengYuJieLong&word=我心如秤

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "next_list": [
            {
                "word": "秤薪而爨",
                "pinyin": "cheng xin er cuan"
            },
            {
                "word": "秤锤落井",
                "pinyin": "cheng chui luo jing"
            },
            {
                "word": "秤不离砣",
                "pinyin": "cheng bu li tuo"
            }
        ]
    },
    "msg": "",
    "_t": 1691647318,
    "_auth": "f196a4ef4cac487cf96be42b472ce7ed"
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.next_list字符串下一批接龙后的多个成语，没有时返回空数组。随机返回最多10个成语
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

由 果创云YesApi.cn 提供技术支持，4万+开发者都在用，累计API调用1,800,000＋万次