天气接口api

天气接口api

天气接口API文档

一、概述

本天气接口API旨在为用户提供实时、准确的全球天气预报服务。通过调用该API,您可以轻松获取指定地区的当前天气状况、未来几天的天气预测以及相关的气象信息。无论是开发个人应用、商业项目还是进行科学研究,本API都能满足您的需求。

二、API接口说明

  1. 基础URL:https://api.weatherprovider.com/v1/

  2. 认证方式

    • API Key:每个用户注册后将获得一个唯一的API Key,用于在请求中验证身份。请在请求头中添加Authorization: Bearer {YOUR_API_KEY}来进行身份验证。
  3. 请求方法:GET

  4. 数据格式:返回的数据格式为JSON。

三、核心接口

  1. 获取当前天气

    • 接口地址:/current/{location}

    • 参数说明

      • {location}:地区名称(如“北京”)或地理坐标(如“lat,lng=39.9042,116.4074”)。
      • lang(可选):语言代码,支持中文("zh")和英文("en"),默认为英文。
    • 示例请求

      GET https://api.weatherprovider.com/v1/current/北京?lang=zh&Authorization=Bearer YOUR_API_KEY
    • 返回字段

      { "status": "success", "data": { "location": "北京", "temperature": "25°C", "weather": "晴", "wind": "东风3级", "humidity": "50%", "time": "2023-10-01T12:00:00Z" } }
  2. 获取未来七天天气预报

    • 接口地址:/forecast/{location}

    • 参数说明

      • {location}:同上。
      • days(可选):预测天数,默认值为7天。
      • lang(可选):同上。
    • 示例请求

      GET https://api.weatherprovider.com/v1/forecast/北京?days=7&lang=zh&Authorization=Bearer YOUR_API_KEY
    • 返回字段

      { "status": "success", "data": [ { "date": "2023-10-02", "temperature": { "min": "20°C", "max": "28°C" }, "weather": "多云", "wind": "南风2级" }, // 更多天的预报... ] }
  3. 获取空气质量指数

    • 接口地址:/aqi/{location}

    • 参数说明

      • {location}:同上。
      • lang(可选):同上。
    • 示例请求

      GET https://api.weatherprovider.com/v1/aqi/北京?lang=zh&Authorization=Bearer YOUR_API_KEY
    • 返回字段

      { "status": "success", "data": { "location": "北京", "aqi": "70", "quality": "良", "pm25": "35μg/m³", "pm10": "55μg/m³", "time": "2023-10-01T12:00:00Z" } }

四、错误处理

当请求失败时,API将返回一个包含错误信息的JSON对象。常见的错误码及描述如下:

  • 400 Bad Request:请求参数有误或缺失。
  • 401 Unauthorized:未提供有效的API Key或API Key已过期。
  • 404 Not Found:指定的资源不存在。
  • 500 Internal Server Error:服务器内部错误。

示例错误响应:

{ "status":