YesApi 接口文档

6001 获取首页广告列表

接口路径(新)：http://hn216.api.okayapi.com/api/App/Market_Adver/GetAdList

接口路径(旧)：http://hn216.api.okayapi.com/?s=App.Market_Adver.GetAdList

接口描述： 获取配置的广告列表，只展示开关为开的前5条数据，使用前请先安装首页广告插件

接口参数 若无特殊说明，接口参数同时支持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通用示例PHP示例 
请求：
{你的接口域名}/?s=App.Market_Adver.GetAdList&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "items": [
            {
                "id": 1,
                "adver_content": "欢迎使用首页广告~",
                "adver_url": "",
                "adver_image": "http://cdn7.okayapi.com/CEE4B8A091578B252AC4C92FB4E893C3_20190123221449_85f0d12a6515ee04e3d370aaae32bc87.png"
            },
            {
                "id": 2,
                "adver_content": "欢迎使用首页广告22~",
                "adver_url": "",
                "adver_image": ""
            },
            {
                "id": 3,
                "adver_content": "欢迎使用首页广告~",
                "adver_url": "",
                "adver_image": ""
            },
            {
                "id": 5,
                "adver_content": "欢迎使用首页广告~",
                "adver_url": "",
                "adver_image": ""
            }
        ]
    },
    "msg": "小白开放接口：App.Market_Adver.GetAdList"
}
<?php

// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';

// 调用小白开放接口
$rs = OkayApiClient::request('App.Market_Adver.GetAdList');
// 输出结果
print_r($rs);

/*
Array 
( 
	[ret] => 200 
	[data] => Array 
	( 
		[err_code] => 0 
		[err_msg] => 
		[items] => Array 
		( 
			[0] => Array ( [id] => 1 [adver_content] => 欢迎使用首页广告~ [adver_url] => [adver_image] => http://cd8.okayapi.com/20180925211646_5e0eee46d8e51ae93158056ee690a149.png ) 
			[1] => Array ( [id] => 2 [adver_content] => 欢迎使用首页广告~ [adver_url] => [adver_image] => http://cd8.okayapi.com/20180925211646_5e0eee46d8e51ae93158056ee690a149.png ) 
			[2] => Array ( [id] => 3 [adver_content] => 欢迎使用首页广告~ [adver_url] => [adver_image] => http://cd8.okayapi.com/20180925211646_5e0eee46d8e51ae93158056ee690a149.png ) 
			[3] => Array ( [id] => 4 [adver_content] => 欢迎使用首页广告~ [adver_url] => [adver_image] => http://cd8.okayapi.com/20180925211646_5e0eee46d8e51ae93158056ee690a149.png ) 
			[4] => Array ( [id] => 5 [adver_content] => 欢迎使用首页广告~ [adver_url] => [adver_image] => http://cd8.okayapi.com/20180925211646_5e0eee46d8e51ae93158056ee690a149.png ) ) 
		)
		[msg] => 小白开放接口：App.Market_Adver.GetAdList 
)
*/

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型操作码，0表示成功，正数表示业务失败场景，负数表示系统失败场景
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
data.items字符串首页广告列表
data.items[].id整型广告ID
data.items[].adver_content字符串广告文案内容
data.items[].adver_url字符串广告的跳转url
data.items[].adver_image字符串广告的图片url
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＋万次