API KEY

API KEY是一种常见、操作简单的身份认证方式。然而API KEY在一些场景下安全性较低,我们推荐使用JWT进行身份验证,可以显著的提高安全等级。

提示:为了提高安全性,从2027年1月1日起,我们将限制使用API KEY进行身份认证的每日请求数量。

生成API KEY

你可以登录控制台快速的生成API KEY:

  1. 点击左侧菜单中的“项目管理”
  2. 点击需要添加API KEY的项目名称
  3. 在凭据设置区域点击绿色的创建凭据按钮
  4. 身份认证方式选择API KEY
  5. 输入凭据名称,比如“旅游APP测试”
  6. 点击创建按钮

你可以随时在控制台-项目管理中查看生成的API KEY。

发送API KEY进行身份验证

注意:请不要同时使用多种身份认证方式,可能会导致身份认证失败。

我们支持两种形式使用API KEY进行身份验证:

请求标头

在你的请求Header中加入X-QW-Api-Key: your-key,例如:

curl -H "X-QW-Api-Key: ABCD1234EFGH" --compressed \
'https://api.qweather.com/v7/weather/now?location=101010100'

请求参数

在请求参数中加入key=your-key,例如:

curl --compressed \
'https://api.qweather.com/v7/weather/now?location=101010100&key=ABCD1234EFGH'