接口支持按年、按月、按日期范围和多个日期批量查询。如按年查询(type=1&date=2020)、按月查询(type=2&date=2020-10)、按日期范围查询(type=3&date=2020-11-1~2020-11-10)、按多个日期批量查询(date=2020-10-1,2020-11-12)
请注意,按年查询只返回中国官方节假日信息;按月查询如只传年月,则为从该月第一天到最后一天;按范围查询,起点和终点用波浪号~分隔;按多个日期批量查询用英文半角逗号分隔。无论哪种查询方式,单次查询所包含的总日期数不能超过31天。
daycode表示日期类型,0表示工作日、1节假日、2双休日、3调休日(需上班)。判断是否需要上班建议用isnotwork字段,其中值为0表示上班,为1表示休息。wage表示薪资倍数,周末为两倍,法定节假日当天为三倍其他两倍(按年查询时返回三倍薪资的具体日期)。
提示:info字段和daycode并非对应关系,建议仅用于日期类型标记;节日指某个具体日期(如2021年1月1号),节假日指整个假期(如2021年1月1号至3号);节日范围宽泛(如会包含植树节、圣诞节),节假日指来自官方发布的有假节日,每年底政府公布后同步更新。
接入点列表:
判断日期是否为官方节假日支持按年、按月和范围批量查询
post方式请求时,enctype应为application/x-www-form-urlencoded
上传文件二进制数据流方式,enctype必须为multipart/form-data
参数url、base64中有特殊字符时,建议对值urlencode编码后传递
名称 | 类型 | 必须 | 示例值/默认值 | 说明 |
---|---|---|---|---|
key | string | 是 | 您自己的APIKEY(注册账号后获得) | API密钥 |
date | string | 是 | 2021-01-01 | 查询日期或日期范围 |
type | int | 是 | 0 | 查询类型,0批量、1按年、2按月、3范围 |
mode | int | 否 | 0 | 查询模式,为1同时返回中外特殊节日信息 |
公共参数指所有接口都会返回的参数,应用参数每个接口都不同
名称 | 类型 | 示例值 | 说明 |
---|---|---|---|
公共参数 | |||
code | int | 200 | 状态码 |
msg | string | success | 错误信息 |
result | object | {} | 返回结果集 |
应用参数 | |||
date | string | 2019-10-01 | 当前阳历日期 |
daycode | int | 1 | 日期类型,为0表示工作日、为1节假日、为2双休日、3为调休日(上班) |
weekday | int | 2 | 星期(数字) |
cnweekday | string | 星期二 | 星期(中文) |
lunaryear | string | 己亥 | 农历年 |
lunarmonth | string | 九月 | 农历月 |
lunarday | string | 初三 | 农历日 |
info | string | 节假日 | 文字提示,工作日、节假日、节日、双休日、调休日 |
start | int | 0 | 假期起点计数 |
now | int | 0 | 假期当前计数 |
end | int | 6 | 假期终点计数 |
update | boolean | true/false | 是否更新法定节假日(按年查询专有字段) |
holiday | string | 10月1日 | 节日日期 |
name | string | 国庆节 | 节假日名称(中文) |
enname | string | National Day | 节日名称(英文) |
isnotwork | int | 1 | 是否需要上班,0为工作日,1为休息日 |
vacation | array | ["2021-01-01","2021-01-02","2021-01-03"] | 节假日数组 |
remark | array | ["2021-12-26","2021-01-08"] | 调休日数组 |
wage | int | 3 | 薪资法定倍数/按年查询时为具体日期 |
tip | string | 10月1日至7日放假调休,共7天...... | 放假提示 |
rest | string | 10月8日至10月10日请假2天,与周末连休可拼11天长假。 | 拼假建议 |
用户等级 | 免费接口数 | 每日可用次数 | 会员价格 | 说明 |
---|---|---|---|---|
普通会员 | 10个 | 100次 | 免费 | 每个免费接口100次/天 |
高级会员 | 不限 | 1万次 | 20元/月、120元/年(限时) | 每个免费接口1W次/天 |
黄金会员 | 不限 | 50万次 | 65元/月、390元/年(限时) | 每个免费接口50W次/天 |
本接口为会员免费类接口,如业务有更高需求可点此升级会员获得更高每日请求配额(年付限时优惠) |
错误信息可能会有所调整,请根据错误状态码(code)进行流程判断
错误状态码 | 错误信息 | 解释帮助 |
---|---|---|
100 | 内部服务器错误 | 报此错误码请及时反馈或等待官方修复 |
110 | 当前API已下线 | 接口已下线无法使用,可关注相关通知 |
120 | API暂时维护中 | 接口暂时关闭维护中,请注意相关公告 |
130 | API调用频率超限 | 超过每秒请求数上限,可在控制台-接口管理中查询 |
140 | API没有调用权限 | 请检查是否自行在接口管理中停用或被禁用了该接口 |
150 | API可用次数不足 | 免费类接口套餐超限或计次类接口余额不足,点此查看说明 |
160 | 账号未申请该API | 请先在接口文档页面申请该接口,点此查看说明 |
170 | Referer请求来源受限 | 设置了Referer白名单,但来源Referer不在白名单内 |
180 | IP请求来源受限 | 设置了IP白名单,但来源IP不在白名单内 |
190 | 当前key不可用 | 通常为账号无效,此状态无法恢复 |
230 | key错误或为空 | 请检查apikey是否填写错误,点此查看帮助 |
240 | 缺少key参数 | 请检查是否传递了key参数或者编码格式是否符合要求 |
250 | 数据返回为空 | 数据查询或转换失败,请检查输入值或注意中文编码问题 |
260 | 参数值不得为空 | 请检查关键参数是否传递了空值 |
270 | 参数值不符合要求 | 参数值不符合基本格式要求,点此查看说明 |
280 | 缺少必要的参数 | 缺少必填的参数,请根据接口文档检查 |
290 | 超过最大输入限制 | 参数值超过输入范围,请查看接口文档的说明 |
错误码1开头的是系统级错误,2开头的是用户级错误,其中200表示请求成功处理并计费。 |