YesApi 接口文档

SVIP.Wxaozhuosen_MyApi.Lunar

接口路径(新):http://api.yesapi.cn/api/SVIP/Wxaozhuosen_MyApi/Lunar

接口路径(旧):http://api.yesapi.cn/?s=SVIP.Wxaozhuosen_MyApi.Lunar

接口描述: 支持返回整个月/日,公农互转。

接口标签:MyApi验签

特别注意:当前 api.yesapi.cn 为临时接口测试域名!请先完成 绑定独立接口域名后 ,才能正式进行API调用。

接口流量
1
请求协议
HTTP/HTTPS
请求方式
GET/POST(推荐POST)
编码格式
UTF-8
返回格式
JSON

在线测试接口    收藏此接口    在线接口开发    接口请求日记


接口参数 若无特殊说明,接口参数同时支持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,欢迎使用小白开放接口!"}
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转换的类型,分别有:
  • 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表示服务端异常,查看异常错误码
dataobject/array/混合接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。
data.lunlist如果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万次接口流量奖励。