YesApi 接口文档

新建接口 v1.4

接口路径(新)：http://hn216.api.okayapi.com/api/SVIP/St2695249_MyApi/AJieKou0705

接口路径(旧)：http://hn216.api.okayapi.com/?s=SVIP.St2695249_MyApi.AJieKou0705

接口描述： 请在这里填写接口的功能说明

接口参数 若无特殊说明，接口参数同时支持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，欢迎使用小白开放接口！"}。

客户端请求示例

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

HTTP通用示例 
{
    "status": 200,
    "apps": [
        {
            "showTagName": "推荐",
            "tagId": "-1",
            "showType": "banner",
            "apps": [
                {
                    "redirectUri": "https:\/\/videotopic.wf.pub\/hellomyjob",
                    "homeUrl": "",
                    "appName": "你好！职场",
                    "loginUrl": "",
                    "logoutUrl": "",
                    "appId": 657,
                    "indexUrl": "hellomyjob",
                    "developer": "sunny--",
                    "logoUrl": "https:\/\/img.wf.pub\/657%2F9955.47584571718-222222.jpg"
                },
                {
                    "redirectUri": "https:\/\/videotopic.wf.pub\/zgsysp",
                    "homeUrl": "",
                    "appName": "中国石油集团经济技术研究院智库传媒",
                    "loginUrl": "",
                    "logoutUrl": "",
                    "appId": 548,
                    "indexUrl": "zgsysp",
                    "developer": "金蘭·宝树",
                    "logoUrl": "https:\/\/img.wf.pub\/548%2F9798.183912436565-%E5%BE%AE%E4%BF%A1%E5%9B%BE%E7%89%87_20211126091007.png"
                },
                {
                    "redirectUri": "https:\/\/nfnyjsqk.wfpub.cn",
                    "homeUrl": "",
                    "appName": "南方能源建设",
                    "loginUrl": "\/logincallback",
                    "logoutUrl": "\/logout",
                    "appId": 588,
                    "indexUrl": "nfnyjsqk",
                    "developer": "Salome",
                    "logoUrl": "https:\/\/img.wf.pub\/588%2F8181.101576065477-%E6%97%A0%E6%A0%87%E9%A2%98.jpg"
                }
            ]
        },
        {
            "showTagName": "毕业论文写作",
            "tagId": "19",
            "showType": "list",
            "apps": [
                {
                    "redirectUri": "https:\/\/videotopic.wf.pub\/paperwriting",
                    "isRecommend": 0,
                    "star": 7,
                    "buyers": 0,
                    "added": false,
                    "appName": "论文写作系列教程",
                    "weight": -100,
                    "indexUrl": "paperwriting",
                    "description": "",
                    "logoUrl": "https:\/\/img.wf.pub\/671%2F1155.087373850463-%E5%BE%AE%E4%BF%A1%E5%9B%BE%E7%89%87_20220506085451.png",
                    "homeUrl": "",
                    "loginUrl": "",
                    "logoutUrl": "",
                    "appId": 671,
                    "developer": "小万",
                    "tag": {
                        "isRecommend": 0,
                        "weight": 108.4
                    },
                    "compatibility": 7,
                    "introduction": "视频系统介绍了论文写作规范及简要排版攻略"
                }
            ]
        },
        {
            "showTagName": "期刊",
            "tagId": "12",
            "showType": "list",
            "apps": [
                {
                    "redirectUri": "https:\/\/nfnyjsqk.wfpub.cn",
                    "isRecommend": 0,
                    "star": 3,
                    "buyers": 0,
                    "added": false,
                    "appName": "南方能源建设",
                    "weight": -100,
                    "indexUrl": "nfnyjsqk",
                    "description": "",
                    "logoUrl": "https:\/\/img.wf.pub\/588%2F8181.101576065477-%E6%97%A0%E6%A0%87%E9%A2%98.jpg",
                    "homeUrl": "",
                    "loginUrl": "\/logincallback",
                    "logoutUrl": "\/logout",
                    "appId": 588,
                    "developer": "Salome",
                    "tag": {
                        "isRecommend": 0,
                        "weight": 92
                    },
                    "compatibility": 7,
                    "introduction": "期刊"
                }
            ]
        },
        {
            "showTagName": "更多",
            "tagId": "-2",
            "showType": "list",
            "apps": [
                {
                    "redirectUri": "https:\/\/videotopic.wf.pub\/videotopic",
                    "isRecommend": 0,
                    "star": 40,
                    "buyers": 0,
                    "added": false,
                    "appName": "《全国科普微视频大赛》作品展播",
                    "weight": 2201,
                    "indexUrl": "videotopic",
                    "description": "",
                    "logoUrl": "https:\/\/img.wf.pub\/10%2F5932.133001115108-QQ.jpg",
                    "homeUrl": "",
                    "loginUrl": "",
                    "logoutUrl": "",
                    "appId": 10,
                    "developer": "科学技术文献出版社",
                    "compatibility": 7,
                    "introduction": ""
                },
                {
                    "redirectUri": "https:\/\/videotopic.wf.pub\/zgsysp",
                    "isRecommend": 0,
                    "star": 1,
                    "buyers": 0,
                    "added": false,
                    "appName": "中国石油集团经济技术研究院智库传媒",
                    "weight": 300,
                    "indexUrl": "zgsysp",
                    "description": "",
                    "logoUrl": "https:\/\/img.wf.pub\/548%2F9798.183912436565-%E5%BE%AE%E4%BF%A1%E5%9B%BE%E7%89%87_20211126091007.png",
                    "homeUrl": "",
                    "loginUrl": "",
                    "logoutUrl": "",
                    "appId": 548,
                    "developer": "金蘭·宝树",
                    "compatibility": 3,
                    "introduction": "科普短视频"
                },
                {
                    "redirectUri": "https:\/\/videotopic.wf.pub\/paperwriting",
                    "isRecommend": 0,
                    "star": 7,
                    "buyers": 0,
                    "added": false,
                    "appName": "论文写作系列教程",
                    "weight": -100,
                    "indexUrl": "paperwriting",
                    "description": "",
                    "logoUrl": "https:\/\/img.wf.pub\/671%2F1155.087373850463-%E5%BE%AE%E4%BF%A1%E5%9B%BE%E7%89%87_20220506085451.png",
                    "homeUrl": "",
                    "loginUrl": "",
                    "logoutUrl": "",
                    "appId": 671,
                    "developer": "小万",
                    "compatibility": 7,
                    "introduction": "视频系统介绍了论文写作规范及简要排版攻略"
                },
                {
                    "redirectUri": "https:\/\/videotopic.wf.pub\/hellomyjob",
                    "isRecommend": 0,
                    "star": 4,
                    "buyers": 0,
                    "added": false,
                    "appName": "你好！职场",
                    "weight": -100,
                    "indexUrl": "hellomyjob",
                    "description": "",
                    "logoUrl": "https:\/\/img.wf.pub\/657%2F9955.47584571718-222222.jpg",
                    "homeUrl": "",
                    "loginUrl": "",
                    "logoutUrl": "",
                    "appId": 657,
                    "developer": "sunny--",
                    "compatibility": 7,
                    "introduction": "针对小白的职场谈话节目，企业资深的HRD带你体会真实的职场"
                },
                {
                    "redirectUri": "https:\/\/nfnyjsqk.wfpub.cn",
                    "isRecommend": 0,
                    "star": 3,
                    "buyers": 0,
                    "added": false,
                    "appName": "南方能源建设",
                    "weight": -100,
                    "indexUrl": "nfnyjsqk",
                    "description": "",
                    "logoUrl": "https:\/\/img.wf.pub\/588%2F8181.101576065477-%E6%97%A0%E6%A0%87%E9%A2%98.jpg",
                    "homeUrl": "",
                    "loginUrl": "\/logincallback",
                    "logoutUrl": "\/logout",
                    "appId": 588,
                    "developer": "Salome",
                    "compatibility": 7,
                    "introduction": "期刊"
                }
            ]
        }
    ]
}

接口返回及数据结构

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

特别注意：当前 hn216.api.okayapi.com 为临时接口测试域名！请先完成 绑定独立接口域名后 ，才能正式进行API调用。

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