接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
grid | 字符串 | 可选 | 取日历方式,D按天取日历,M按月取日历,为空默认是(日) | ||
is_Lunar | 字符串 | 可选 | 是否农历转公立 | ||
month | 字符串 | 必须 | 年 如果year_type有值,取绝对值,否则为 按照公元的算法,负数是公元前,正数为公元后 (为空取今年) | ||
year | 字符串 | 必须 | 年 如果year_type有值,取绝对值,否则为 按照公元的算法,负数是公元前,正数为公元后 (为空取今年) | ||
day | 字符串 | 必须 | 月 (year以及month 为空 取今天的年和月,只有month 为空则1) | ||
traditional_chinese | 字符串 | 可选 | 0 | 为1的时候就会把所有返回的繁体字体 | |
type | 枚举类型 | 可选 | s2t | 范围:s2t/s2tw/s2hk/s2twp | 转换的类型,分别有:
|
在线测试
参数 | 是否必填 | 值 |
---|---|---|
s | 固定 | |
uuid | 可选 | |
token | 可选 | |
return_data | 可选 | |
grid | 可选 | |
is_Lunar | 可选 | |
month | 必须 | |
year | 必须 | |
day | 必须 | |
traditional_chinese | 可选 | |
type | 可选 |
客户端请求示例
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=SVIP.Wxaozhuosen_MyApi.Lunar&app_key=922B4F9902885C6894202C4CC208A668&grid=d&year=-1111&month=12&day=1&is_lunnar=1
返回:
{
"ret": 200,
"data": {
"lun": {
"d0": -1135918,
"di": 27,
"y": -1111,
"m": 12,
"dn": 31,
"week0": 0,
"week": 6,
"weeki": 3,
"weekN": 5,
"d": 28,
"Ldi": 0,
"Ldc": "初一",
"cur_dz": 363,
"cur_xz": 177,
"cur_lq": 131,
"cur_mz": 193,
"cur_xs": 162,
"Lmc": 13,
"Ldn": 29,
"Lleap": "",
"Lmc2": "未知",
"Ljq": "",
"Lyear": -3095,
"Lyear0": -3095,
"Lyear2": "己丑",
"Lyear3": "己丑",
"Lyear4": 1587,
"Lmonth": 0,
"Lmonth2": "丙子",
"Lday2": "庚申",
"XiZ": "射手座",
"A": "",
"B": "",
"C": "",
"Fjia": 1
},
"Ly": "己丑",
"Shx": "牛",
"Dn": 31,
"Y": -1111,
"M": 12,
"D": 28,
"NianHao": "[商]匡王 子托 文丁1年",
"Time": 0.03154706954956055
},
"msg": "",
"_t": 1676002030,
"_auth": "6ffe5e5ec65503e00141eee7adcd5783"
}
接口返回及数据结构
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.lun | list | 如果gird是d返回一个对象 如果 gird输入是M(月份)返回公历的一个数组 |
data.y | 字符串 | 公历年份 |
data.m | 字符串 | 公历月分 |
data.d0 | 字符串 | 月首儒略日数 |
data.dn | 字符串 | 月天数 |
data.Ly | 字符串 | 干支纪年 |
data.ShX | 字符串 | 该年对应的生肖 |
data.nianhao | 字符串 | 年号纪年 |
data.time | 字符串 | 计算花费的时间 |
data.chinese_time | 字符串 | 中文翻译花费的时间 (second) |
data.lun.ob.d0 | 字符串 | 2000.0起算儒略日,北京时12:00 |
data.lun.ob.di | 字符串 | 所在公历月内日序数 |
data.lun.ob.y | 字符串 | 所在公历年,同lun.y |
data.lun.ob.m | 字符串 | 所在公历月,同lun.m |
data.lun.ob.d | 字符串 | 日名称(公历) |
data.lun.ob.dn | 字符串 | 所在公历月的总天数 |
data.lun.ob.week0 | 字符串 | 所在月的月首的星期 |
data.lun.ob.week | 字符串 | 星期 |
data.lun.ob.weeki | 字符串 | 在本月中的周序号 |
data.lun.ob.weekN | 字符串 | 本月的总周数 |
data.lun.cur_xz | 字符串 | 距夏至的天数 |
data.lun.cur_lq | 字符串 | 距立秋的天数 |
data.lun.cur_mz | 字符串 | 距芒种的天数 |
data.lun.cur_xs | 字符串 | 距小暑的天数 |
data.lun.Lyear | 字符串 | 农历纪年(10进制,1984年起算,分界点可以是立春也可以是春节,在程序中选择一个) |
data.lun.Lyear2 | 字符串 | 干支纪年 |
data.lun.Lmonth | 字符串 | 纪月处理,1998年12月7日(大雪)开始连续进行节气计数,0为甲子 |
data.lun.Lmonth2 | 字符串 | 干支纪月 |
data.lun.Lday2 | 字符串 | 纪日 |
data.lun.Ltime2 | 字符串 | 纪时 |
data.lun.XiZ | 字符串 | 星座 |
data.lun.Lmc | 字符串 | 月名称 |
data.lun.Ldi | 字符串 | 距农历月首的编移量,0对应初一 |
data.lun.Ldc | 字符串 | 日名称(农历),即'初一,初二等' |
data.lun.Ldn | 字符串 | 月大小 |
data.lun.Lmc2 | 字符串 | 下个月名称,判断除夕时要用到 |
data.lun.Hyear | 字符串 | 年(回历) |
data.lun.Hmonth | 字符串 | 月(回历) |
data.lun.Hday | 字符串 | 日(回历) |
data.lun.A | 字符串 | 重要喜庆日子名称(可将日子名称置红) |
data.lun.B | 字符串 | 重要日子名称 |
data.lun.C | 字符串 | 各种日子名称(连成一大串) |
data.lun.Fjia | 字符串 | 放假日子(可用于日期数字置红) |
data.lun.Lleap | 字符串 | 是否闰月 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
ret异常错误码
错误码 | 错误类型 | 错误描述信息 | 解决方法 |
---|---|---|---|
ret = 200 | 成功 | 请求成功 | |
ret = 400 | 客户端非法请求 | 表示客户端参数错误 | 1、根据接口文档的接口参数,提供正确的参数 |
ret = 404 | 客户端非法请求 | 表示接口服务不存在 | 1、查看小白接口大全,确保接口服务名称拼写正确 |
ret = 500 | 小白接口异常 | 表示服务端内部错误 | 1、进入QQ交流群897815708,反馈问题;2、或者提交工单,一天内回复 |
常见问题FAQ
Q1 问:出现 414 Request-URI Too Large 时怎么解决?答:对于全部参数,改用POST方式传递,并且从GET链接里面去掉。
Q2 问:浏览器请求和在线测试接口正常,但本地程序无法正常获取接口结果。答:需要注意UTF编码,以及存在中文和特殊字符时的URL编码。GET请求参数应统一进行URL编码后再请求,POST表单数据正常传递即可。
Q3 问:请求接口时提示JSON格式错误。答:请先阅读,然后检测本地传递的参数是否符合JSON格式,使用JSON在线工具辅助检测,注意双引号和特殊符号。确认无误后再重新请求API接口。
Q4 问:出现 405 不允许跨域请求 时怎么办?答:可以追加GET参数 &yesapi_allow_origin=1
,或参考用反向代理解决跨域问题等3种解决方案。
Q4 问:在wx内无法访问yesapi.cn或okayapi.com域名,怎么办?答:由于曾经短链跳转使用被wx误封域名,可以帮忙进行申诉。申诉后截图联系我们,获取15万次接口流量奖励。