calendarific-全球节日和纪念日
专用API
服务商:
calendarific
【更新时间: 2024.06.11】
Calendarific 是一个对开发人员友好的全球 RESTful 应用程序接口,可让您访问公共、地方和银行节日和纪念日,覆盖 230 多个国家、3300 多个州和 100 多种语言。
|
- API详情
- 定价
- 使用指南
- 常见 FAQ
- 关于我们
- 相关推荐
什么是全球节日和纪念日的calendarific?
Calendarific 是一个企业级的全球节假日和公众假期API,它为全球超过230个国家提供详尽的节假日数据及工作时间信息。该API旨在帮助开发者和企业无缝地将节假日信息整合到他们的应用程序、网站或服务中。通过Calendarific,用户可以获取包括国家法定假日、地方性庆祝活动、宗教节日等在内的丰富节日数据,甚至可以根据特定国家或地区进行数据定制。
什么是全球节日和纪念日的calendarific?
全球节日和纪念日的calendarific有哪些核心功能?
-
全球节假日数据:提供超过230个国家的全面节假日信息,包括国家法定假日、地方性节日、宗教纪念日等。
-
多国语言与地区支持:支持超过100种语言和3300个地区的数据,可高度定制化查询特定区域的节日信息。
全球节日和纪念日的calendarific的核心优势是什么?
速度我们使用基于延迟的 DNS 路由,在 10 毫秒内处理了 90% 以上的请求。 |
可靠性我们基于云的自动扩展服务器每天可处理超过 5 亿次 API 查询。 |
最新信息我们的数据由多个来源汇总和验证,并定期更新。 |
在哪些场景会用到全球节日和纪念日的calendarific?
电子商务与零售行业: 在线电商平台或零售业务可以利用Calendarific API来智能调整营销策略。例如,在特定国家的节日来临前,电商平台可以推送节日相关的商品促销信息,或者调整库存以应对可能的销售高峰,如圣诞节、感恩节或春节等重大节日,从而提升销售额和用户体验。
|
|
人力资源管理系统: 企业的人力资源部门可以集成Calendarific API来自动管理员工的假期安排。系统可以根据员工所在国家的公共假期自动调整休假安排,避免在节假日安排工作,同时帮助计算员工的带薪假期天数,确保符合当地劳动法规,提高管理效率和员工满意度。 |
|
|
每月 | 每年 |
全球假日应用程序接口文档
API 基本 URL
对我们 API 的所有请求都应发送到此端点。以下是应用程序接口支持的端点列表
h
ttps://
calendarific.com/api/v2
应用程序接口端点
以下是我们目前支持的 API 端点列表。请注意,对任何这些端点的请求都将计入您的 API 点击配额。如果您使用的是免费计划,它将计入您的配额。
/节假日 |
根据传递给它的参数提供假期列表。 | https://calendarific.com/api/v2/holidays |
/语言 |
该端点提供我们支持的语言列表。请注意,并非所有节假日都以所列语言指定。如果指定的语言中没有节假日,则在大多数情况下会默认为该国的官方语言或英语。 这对于以编程方式获取所有语言的索引和 ISO 代码非常有用。 | https://calendarific.com/api/v2/languages |
/countries |
该端点提供了我们支持的国家和语言列表。可用于以编程方式获取所有国家的索引和 ISO 代码。 | https://calendarific.com/api/v2/countries |
身份验证
向假日应用程序接口提出的每个请求都需要一个应用程序接口密钥。您的 API 密钥用于通过我们的 API 进行身份验证,应作为api_key
URL 参数提供。
API 密钥可从账户页面获取。如果您不知道自己的 API 密钥,请注册获取免费账户密钥。
?api_key=baa9dc110aa712sd3a9fa2a3dwb6c01d4c875950dc32vs
api_key
应附加到 url 请求中,如下例所示
curl -G https://calendarific.com/api/v2/holidays?api_key=baa9dc110aa712sd3a9fa2a3dwb6c01d4c875950dc32vs
假日应用程序接口端点参数
我们使用 URL 参数对 API 进行查询。有两组参数,即可选参数和必选参数。对于假日 API。国家
、年份
和api_key
是所有假日 API 请求的必填参数。 不包含必填参数的请求将收到错误响应,无法处理。
必填 API 参数
api_key |
这是 API 的值,用于验证对我们 API 的每个请求。 您可以在注册并登录账户后访问该值。这是/countries 端点唯一需要的参数。 |
国家/地区 |
国家参数必须采用此处文档 中指定的 iso-3166 格式。 要查看我们支持的国家和地区列表,请访问我们的支持 国家 列表 。 |
年份 |
您希望返回假期的年份。我们目前支持历史年份和未来年份,直至 2049 年。年份必须指定为数字,例如2019 |
下面是一个请求 2019 年美国所有节假日的示例。请确保将api_key
替换为账户页面上的有效值。
curl 'https://calendarific.com/api/v2/holidays?&api_key=baa9dc110aa712sd3a9fa2a3dwb6c01d4c875950dc32vs&country=US&year=2019'
以下是成功执行的简短 API 响应
{ "meta":{ "code":200 }, "response":{ "假日":[ { "name":"假期名称请点击此处", "description":"假期描述请点击此处","日期":{ "iso":"2018-12-31", "datetime":{ "year":2018, "month":12, "day":31 } }, "类型":["纪念类型在此显示"
可选的假日 API 端点参数
我们的 API 有一系列可选参数,允许用户完善返回的结果。请注意,某些可选参数仅限付费用户使用。以下是可选参数的完整列表
注意:可在请求中指定多个类型,以逗号分隔。
天数 |
将假期数量限制在某一天。必须以日[1 ...31 ]的数值形式传递。 |
月 |
将节假日数量限制为某个特定月份。必须以月份[1 ..12 ] 的数值形式传递。 |
地点 |
我们支持所有国家的多个县、州和地区。 通过这个可选参数,您可以将节假日限制在特定的州或地区。字段值是州的iso-3166 格式 。查看支持的国家和州列表。例如,对于美国纽约州,应为us-ny |
类型 |
我们支持多种类型的节日和纪念日。该参数允许用户只返回特定类型的节日或活动。默认情况下,API 会返回所有节日。以下是 API 支持的节日类型列表,以及如何引用这些类型。
|
高级假日 API 端点参数
我们的 API 支持高级参数,专业版及以上版本的所有用户均可使用这些参数。如果您在没有订阅的情况下使用这些参数,将会收到错误信息。
语言 |
以国家官方语言(如果有)返回假期名称。 默认为英语。必须以2 个字母的 ISO639 语言代码形式传递。例如,如果要返回所有法国法定假日的法语名称,只需添加如下参数:&language=fr |
UUID |
为响应中返回的每个假日返回一个 UUID[true(真 )或false(假 )]。 |
HTTP 响应代码
每个 API 请求都会返回相应的 HTTP 响应代码,下面列出了这些代码在 API 中的含义
200 |
成功 一切顺利。 |
401 |
未授权 头信息中的 API 标记缺失或不正确。 |
422 |
无法处理的实体,意思是信息有问题,可能是 JSON 格式不正确或字段不正确。在这种情况下,响应体包含带有 API 错误代码和信息的 JSON,其中包含出错的详细信息。 |
500 |
内部服务器错误 这是 Calendarific 服务器在处理您的请求时出现的问题。在大多数情况下,信息会在处理过程中丢失,我们会收到通知,以便对问题进行调查。 |
503 |
服务不可用 在计划的服务中断期间,Calendarific API 服务将返回此 HTTP 响应和相关 JSON 主体。 |
429 |
请求过多。达到 API 限制。 |
API 错误代码
只要 Calendarific 服务器检测到输入错误,就会返回 HTTP 422 状态代码以及包含错误详细信息的 JSON 对象:
600 |
维护 Calendarific API 离线维护。 |
601 |
未授权 缺少或不正确的 API 令牌。 |
602 |
查询参数无效。 |
603 |
已授权 需要订阅级别。 |
JSON 响应
当有人想调用我们的应用程序接口或浏览我们的网站时,我们会尝试自动检测,并发回适当的 JSON 响应,而不是 HTML。我们这样做是基于已知流行编程语言、工具和框架的用户代理。不过,在无法自动生成 JSON 响应的情况下,我们还有其他一些方法来强制生成 JSON 响应。一种是在 URL 中添加 /json,另一种是将接受标头设置为 application/json:
速率限制
每天免费使用我们的 API 的次数限制为 1,000 次。如果在 24 小时内超过 1,000 次请求,我们将返回 429 HTTP 状态代码。付费计划提供月度限制和可配置的警报。
JSONP/CORS 请求
支持 JSONP 和 CORS,允许您完全在客户端代码中使用 Calendarific。 对于 JSONP,您只需指定回调参数,例如
https://calendarific.com/?callback=callback
增强全球各行业的能力
Calendarific 的指数式增长证明了其追求卓越的坚定承诺。如今,我们为来自各行各业的 50,000 多名客户提供服务。金融、银行、教育、旅游、供应链--不胜枚举。人力资源专业人士、分析师和规划师利用 API 的强大功能来应对复杂的日程安排挑战,超越了其最初设想的界限。
全球努力
在一个由跨国公司和相互交织的全球经济所主导的世界里,准确的节假日数据的重要性怎么强调都不为过。Calendarific 始终站在最前沿,提供全球和地区范围内公共假日和银行假日的最新信息。API 的全面覆盖确保满足最复杂的跨境业务需求。
重塑多部门战略
随着组织结构日趋复杂,高效的多部门解决方案变得至关重要。Calendarific 应运而生,成为解决节假日日程安排复杂问题的万能药。从大型企业到敏捷的初创公司,API 提供了一条生命线,释放了宝贵的资源,简化了运营。
追求卓越
我们 Calendarific 投入了巨大的精力,对 API 的准确性和效率进行了微调,他们也始终乐于接受反馈意见。我们鼓励用户报告任何不一致或遗漏的假日信息,以便立即进行更新,这也是我们孜孜不倦追求卓越的最好证明。
在全球假日跟踪的动态世界中,Calendarific 是无可争议的开拓者。它对开发人员友好的方法、广泛的覆盖范围以及对客户满意度的坚定承诺,改变了全球各行业管理节日庆祝活动的方式。随着企业不断驾驭复杂的现代环境,Calendarific 成为可靠性、效率和创新的灯塔--为未来的假日 API 树立了标准。
每月 | 每年 |
全球假日应用程序接口文档
API 基本 URL
对我们 API 的所有请求都应发送到此端点。以下是应用程序接口支持的端点列表
h
ttps://
calendarific.com/api/v2
应用程序接口端点
以下是我们目前支持的 API 端点列表。请注意,对任何这些端点的请求都将计入您的 API 点击配额。如果您使用的是免费计划,它将计入您的配额。
/节假日 |
根据传递给它的参数提供假期列表。 | https://calendarific.com/api/v2/holidays |
/语言 |
该端点提供我们支持的语言列表。请注意,并非所有节假日都以所列语言指定。如果指定的语言中没有节假日,则在大多数情况下会默认为该国的官方语言或英语。 这对于以编程方式获取所有语言的索引和 ISO 代码非常有用。 | https://calendarific.com/api/v2/languages |
/countries |
该端点提供了我们支持的国家和语言列表。可用于以编程方式获取所有国家的索引和 ISO 代码。 | https://calendarific.com/api/v2/countries |
身份验证
向假日应用程序接口提出的每个请求都需要一个应用程序接口密钥。您的 API 密钥用于通过我们的 API 进行身份验证,应作为api_key
URL 参数提供。
API 密钥可从账户页面获取。如果您不知道自己的 API 密钥,请注册获取免费账户密钥。
?api_key=baa9dc110aa712sd3a9fa2a3dwb6c01d4c875950dc32vs
api_key
应附加到 url 请求中,如下例所示
curl -G https://calendarific.com/api/v2/holidays?api_key=baa9dc110aa712sd3a9fa2a3dwb6c01d4c875950dc32vs
假日应用程序接口端点参数
我们使用 URL 参数对 API 进行查询。有两组参数,即可选参数和必选参数。对于假日 API。国家
、年份
和api_key
是所有假日 API 请求的必填参数。 不包含必填参数的请求将收到错误响应,无法处理。
必填 API 参数
api_key |
这是 API 的值,用于验证对我们 API 的每个请求。 您可以在注册并登录账户后访问该值。这是/countries 端点唯一需要的参数。 |
国家/地区 |
国家参数必须采用此处文档 中指定的 iso-3166 格式。 要查看我们支持的国家和地区列表,请访问我们的支持 国家 列表 。 |
年份 |
您希望返回假期的年份。我们目前支持历史年份和未来年份,直至 2049 年。年份必须指定为数字,例如2019 |
下面是一个请求 2019 年美国所有节假日的示例。请确保将api_key
替换为账户页面上的有效值。
curl 'https://calendarific.com/api/v2/holidays?&api_key=baa9dc110aa712sd3a9fa2a3dwb6c01d4c875950dc32vs&country=US&year=2019'
以下是成功执行的简短 API 响应
{ "meta":{ "code":200 }, "response":{ "假日":[ { "name":"假期名称请点击此处", "description":"假期描述请点击此处","日期":{ "iso":"2018-12-31", "datetime":{ "year":2018, "month":12, "day":31 } }, "类型":["纪念类型在此显示"
可选的假日 API 端点参数
我们的 API 有一系列可选参数,允许用户完善返回的结果。请注意,某些可选参数仅限付费用户使用。以下是可选参数的完整列表
注意:可在请求中指定多个类型,以逗号分隔。
天数 |
将假期数量限制在某一天。必须以日[1 ...31 ]的数值形式传递。 |
月 |
将节假日数量限制为某个特定月份。必须以月份[1 ..12 ] 的数值形式传递。 |
地点 |
我们支持所有国家的多个县、州和地区。 通过这个可选参数,您可以将节假日限制在特定的州或地区。字段值是州的iso-3166 格式 。查看支持的国家和州列表。例如,对于美国纽约州,应为us-ny |
类型 |
我们支持多种类型的节日和纪念日。该参数允许用户只返回特定类型的节日或活动。默认情况下,API 会返回所有节日。以下是 API 支持的节日类型列表,以及如何引用这些类型。
|
高级假日 API 端点参数
我们的 API 支持高级参数,专业版及以上版本的所有用户均可使用这些参数。如果您在没有订阅的情况下使用这些参数,将会收到错误信息。
语言 |
以国家官方语言(如果有)返回假期名称。 默认为英语。必须以2 个字母的 ISO639 语言代码形式传递。例如,如果要返回所有法国法定假日的法语名称,只需添加如下参数:&language=fr |
UUID |
为响应中返回的每个假日返回一个 UUID[true(真 )或false(假 )]。 |
HTTP 响应代码
每个 API 请求都会返回相应的 HTTP 响应代码,下面列出了这些代码在 API 中的含义
200 |
成功 一切顺利。 |
401 |
未授权 头信息中的 API 标记缺失或不正确。 |
422 |
无法处理的实体,意思是信息有问题,可能是 JSON 格式不正确或字段不正确。在这种情况下,响应体包含带有 API 错误代码和信息的 JSON,其中包含出错的详细信息。 |
500 |
内部服务器错误 这是 Calendarific 服务器在处理您的请求时出现的问题。在大多数情况下,信息会在处理过程中丢失,我们会收到通知,以便对问题进行调查。 |
503 |
服务不可用 在计划的服务中断期间,Calendarific API 服务将返回此 HTTP 响应和相关 JSON 主体。 |
429 |
请求过多。达到 API 限制。 |
API 错误代码
只要 Calendarific 服务器检测到输入错误,就会返回 HTTP 422 状态代码以及包含错误详细信息的 JSON 对象:
600 |
维护 Calendarific API 离线维护。 |
601 |
未授权 缺少或不正确的 API 令牌。 |
602 |
查询参数无效。 |
603 |
已授权 需要订阅级别。 |
JSON 响应
当有人想调用我们的应用程序接口或浏览我们的网站时,我们会尝试自动检测,并发回适当的 JSON 响应,而不是 HTML。我们这样做是基于已知流行编程语言、工具和框架的用户代理。不过,在无法自动生成 JSON 响应的情况下,我们还有其他一些方法来强制生成 JSON 响应。一种是在 URL 中添加 /json,另一种是将接受标头设置为 application/json:
速率限制
每天免费使用我们的 API 的次数限制为 1,000 次。如果在 24 小时内超过 1,000 次请求,我们将返回 429 HTTP 状态代码。付费计划提供月度限制和可配置的警报。
JSONP/CORS 请求
支持 JSONP 和 CORS,允许您完全在客户端代码中使用 Calendarific。 对于 JSONP,您只需指定回调参数,例如
https://calendarific.com/?callback=callback
增强全球各行业的能力
Calendarific 的指数式增长证明了其追求卓越的坚定承诺。如今,我们为来自各行各业的 50,000 多名客户提供服务。金融、银行、教育、旅游、供应链--不胜枚举。人力资源专业人士、分析师和规划师利用 API 的强大功能来应对复杂的日程安排挑战,超越了其最初设想的界限。
全球努力
在一个由跨国公司和相互交织的全球经济所主导的世界里,准确的节假日数据的重要性怎么强调都不为过。Calendarific 始终站在最前沿,提供全球和地区范围内公共假日和银行假日的最新信息。API 的全面覆盖确保满足最复杂的跨境业务需求。
重塑多部门战略
随着组织结构日趋复杂,高效的多部门解决方案变得至关重要。Calendarific 应运而生,成为解决节假日日程安排复杂问题的万能药。从大型企业到敏捷的初创公司,API 提供了一条生命线,释放了宝贵的资源,简化了运营。
追求卓越
我们 Calendarific 投入了巨大的精力,对 API 的准确性和效率进行了微调,他们也始终乐于接受反馈意见。我们鼓励用户报告任何不一致或遗漏的假日信息,以便立即进行更新,这也是我们孜孜不倦追求卓越的最好证明。
在全球假日跟踪的动态世界中,Calendarific 是无可争议的开拓者。它对开发人员友好的方法、广泛的覆盖范围以及对客户满意度的坚定承诺,改变了全球各行业管理节日庆祝活动的方式。随着企业不断驾驭复杂的现代环境,Calendarific 成为可靠性、效率和创新的灯塔--为未来的假日 API 树立了标准。