批量获取 API

访问限制

本部分 API 属于增值服务，仅提供给企业套餐开发者，如需采购请联系彩云商务

TIP

目前支持中国的气象预警信息，其他国家和地区的预警信息正在逐步增加中。

每次调用消耗接口调用额度一次。

本接口重点为需要在地图叠加全国预警分布的客户提供一个方便的批量获取 API。 直接返回 GeoJSON 格式的数据，方便直接和地图交互。

• 错误信息 | 支持范围与数据粒度

请求

GET https://singer.caiyunhub.com/v3/alert/all

查询参数

参数	必填	默认值	取值范围	说明
token	是	—	—	API 认证凭证，详见 认证与鉴权
region_code	否	CN	CN	ISO 3166-1 地区编码

请求示例

curl "https://singer.caiyunhub.com/v3/alert/all?token={token}&region_code=CN" \
     -H 'If-None-Match: 123hfjkds678' \
     -H 'Accept-Encoding: gzip, zlib, deflate, zstd, br'

正常情况下，接口在 Response Header 中会含有一个 x-cy-etag 值，在下一次调用时将 Etag 值赋给请求 Header 中的 If-None-Match， 如果返回 HTTP 304 则表示数据没有变化，可以直接使用上一次的数据。

响应示例

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": { "type": "Point", "coordinates": [118.702032, 41.018482] },
      "id": "ALERT_CN_13088141600000_20240806111120",
      "properties": {
        "alert_type": 156110214,
        "area_code": "130881",
        "color": { "red": 250, "green": 230 },
        "data": [
          {
            "language_code": "zh-CN",
            "title": "平泉市气象台发布雷电黄色预警[Ⅲ级/较重]",
            "text": "平泉市气象台2024年08月06日11时10分发布雷电黄色预警信号：预计未来6小时内，我市全部乡镇将受雷电天气影响，雷雨时可能伴有雷暴大风、短时强降水和冰雹等强对流天气，请注意防范。（数据来源：国家预警信息发布中心）",
            "name": "雷电黄色预警"
          }
        ],
        "id": "ALERT_CN_13088141600000_20240806111120",
        "publish_time": 1722913880,
        "region_code": "CN",
        "source": 1,
        "status": 1
      }
    },
    {
      "type": "Feature",
      "geometry": { "type": "Point", "coordinates": [125.744654, 42.284594] },
      "id": "ALERT_CN_22052441600000_20240806103348",
      "properties": {
        "alert_type": 156110214,
        "area_code": "220524",
        "color": { "red": 250, "green": 230 },
        "data": [
          {
            "language_code": "zh-CN",
            "title": "柳河县气象台 发布雷电黄色预警[III级/较重]",
            "text": "预计未来6小时内，我县有分布不均的雷电天气，可能会造成雷电灾害，局部地方伴有短时强降水、雷暴大风或冰雹等强对流天气，县应急局与县气象局联合提醒相关部门和广大群众注意加强防范（数据来源：国家预警信息发布中心）",
            "name": "雷电黄色预警"
          }
        ],
        "id": "ALERT_CN_22052441600000_20240806103348",
        "publish_time": 1722911788,
        "region_code": "CN",
        "source": 1,
        "status": 1
      }
    }
  ]
}

响应字段

JSONPath	类型	说明
$.type	string	GeoJSON 类型，固定为 FeatureCollection
$.features	array<object>	预警要素列表
$.features[].geometry	object	预警位置 GeoJSON 几何对象
$.features[].id	string	预警唯一标识
$.features[].properties	object	预警属性，字段同单点查询记录