节假日查询

商品介绍

把一个日期区间（最多 93 天）内的每一天分类为工作日、周末、法定节假日或调休上班日。中国大陆请用 holiday-cn，它包含调休信息。 ## 数据源 请求中的 `provider` 从以下数据源中选择： - `gov-uk` (gb) - `holiday-cn` (cn) ## 调用与计费 - 调用 ID（`invocation_id`）由市场网关写入，请求中无需携带，携带的值会被替换。 - 只有服务返回执行成功（`data.execution.outcome` 为 `succeeded`）的调用按一次请求计费；参数错误、数据源失败和结果未知的调用不计费。 - 服务在 `data.execution.usage.units` 中报告用量，单位为 `days`。

价格

以上为公开标价。你的组织可能有协议价，以控制台显示的价格为准。

档位

档位

zgiservices · standard

档位标识

zgi-public-holiday-standard

接口协议

HTTP 接口

如何使用

1. 1

   为组织开通

   在控制台为组织开通此商品。开通后即可调用，不需要你自己的厂商账号。

2. 2

   创建凭证

   在控制台“凭证”中创建一个凭证。密钥只显示一次，请保存到环境变量 ZGI_MARKET_KEY，并在每次请求中携带：

   Authorization: Bearer $ZGI_MARKET_KEY

   也可以使用 X-API-Key 请求头。一份凭证可以调用组织已开通的所有商品。

3. 3

   调用网关

   沿用厂商原有的请求与响应格式，只需把 Base URL 和密钥换成下面的值。

   Base URL

   https://market-api.zgi.im/v1/gateway/zgi-public-holiday-standard

   curl -X POST "https://market-api.zgi.im/v1/gateway/zgi-public-holiday-standard/v1/public-holiday-queries" \
     -H "Authorization: Bearer $ZGI_MARKET_KEY" \
     -H "Content-Type: application/json" \
     -d '{}'

   入参与输出

   各操作的入参和输出结构，以 JSON Schema 描述。

   POST /v1/public-holiday-queries

   {
     "type": "object",
     "required": [
       "provider",
       "region",
       "start_date",
       "end_date"
     ],
     "properties": {
       "region": {
         "type": "string",
         "description": "ISO 3166-1 alpha-2 region code, for example CN, GB, DE or US."
       },
       "end_date": {
         "type": "string",
         "description": "Last date, YYYY-MM-DD, inclusive; at most 93 days after start_date."
       },
       "provider": {
         "enum": [
           "gov-uk",
           "holiday-cn"
         ],
         "type": "string",
         "description": "Provider that serves the request; choose by the coverage described for this tool."
       },
       "start_date": {
         "type": "string",
         "description": "First date, YYYY-MM-DD."
       }
     },
     "additionalProperties": false
   }

   {
     "type": "object",
     "required": [
       "code",
       "data"
     ],
     "properties": {
       "code": {
         "type": "integer"
       },
       "data": {
         "type": "object",
         "required": [
           "execution",
           "result"
         ],
         "properties": {
           "result": {
             "type": "object",
             "required": [
               "region",
               "start_date",
               "end_date",
               "days",
               "totals",
               "source"
             ],
             "properties": {
               "days": {
                 "type": [
                   "array",
                   "null"
                 ],
                 "items": {
                   "type": "object",
                   "required": [
                     "date",
                     "weekday",
                     "day_type",
                     "is_off_day",
                     "holiday_name"
                   ],
                   "properties": {
                     "date": {
                       "type": "string"
                     },
                     "weekday": {
                       "type": "integer"
                     },
                     "day_type": {
                       "type": "string"
                     },
                     "is_off_day": {
                       "type": "boolean"
                     },
                     "holiday_name": {
                       "type": [
                         "string",
                         "null"
                       ]
                     }
                   }
                 }
               },
               "region": {
                 "type": "string"
               },
               "source": {
                 "type": "object",
                 "required": [
                   "name",
                   "license",
                   "announcements"
                 ],
                 "properties": {
                   "name": {
                     "type": "string"
                   },
                   "license": {
                     "type": "string"
                   },
                   "announcements": {
                     "type": [
                       "array",
                       "null"
                     ],
                     "items": {
                       "type": "string"
                     }
                   }
                 }
               },
               "totals": {
                 "type": "object",
                 "required": [
                   "workdays",
                   "off_days"
                 ],
                 "properties": {
                   "off_days": {
                     "type": "integer"
                   },
                   "workdays": {
                     "type": "integer"
                   }
                 }
               },
               "end_date": {
                 "type": "string"
               },
               "start_date": {
                 "type": "string"
               }
             }
           },
           "execution": {
             "type": "object",
             "description": "The recorded execution: id, invocation_id, outcome, usage, and timing."
           }
         }
       },
       "message": {
         "type": "string"
       }
     }
   }

来源与审核

审核状态

未记录

来源文档

https://services.zgi.im/capabilities/public-holiday/

许可证

未说明

审核状态是平台对上架信息的记录，不构成对上游服务质量或可用性的担保。