From 601e9c42d024c8d86f4e0cededac4197cb295b00 Mon Sep 17 00:00:00 2001 From: QWRDA <49384329+QWRDA@users.noreply.github.com> Date: Fri, 23 Feb 2024 15:57:05 +0800 Subject: [PATCH] docs: format anchor link (#124) --- docs/_en/configuration/ios-sdk-config.md | 2 +- docs/_zh/account/developers.md | 4 +- docs/_zh/account/inactive.md | 6 +- docs/_zh/account/recipients.md | 8 +-- docs/_zh/account/suspension.md | 6 +- docs/_zh/best-practices/cache.md | 2 +- docs/_zh/best-practices/protect-data-key.md | 12 ++-- docs/_zh/configuration/android-sdk-config.md | 10 +-- docs/_zh/configuration/api-config.md | 8 +-- docs/_zh/configuration/ios-sdk-config.md | 16 ++--- docs/_zh/configuration/project-and-key.md | 10 +-- docs/_zh/features/global-deployment.md | 8 +-- docs/_zh/features/performance.md | 2 +- docs/_zh/features/service-and-data.md | 18 ++--- docs/_zh/finance/billing-and-payment.md | 12 ++-- docs/_zh/finance/pricing.md | 6 +- docs/_zh/finance/saving-plans.md | 16 ++--- docs/_zh/finance/vat-invoice.md | 4 +- docs/_zh/resource/icons.md | 14 ++-- docs/_zh/resource/signature-auth.md | 4 +- docs/_zh/resource/sun-moon-info.md | 6 +- docs/_zh/resource/unit.md | 4 +- docs/_zh/resource/wind-info.md | 6 +- docs/_zh/start.md | 6 +- docs/_zh/terms/attribution.md | 8 +-- docs/_zh/terms/license.md | 4 +- docs/_zh/terms/restriction.md | 12 ++-- pages/en/help.md | 4 +- pages/zh/help.md | 74 ++++++++++---------- 29 files changed, 145 insertions(+), 147 deletions(-) diff --git a/docs/_en/configuration/ios-sdk-config.md b/docs/_en/configuration/ios-sdk-config.md index 01513fa..9654854 100644 --- a/docs/_en/configuration/ios-sdk-config.md +++ b/docs/_en/configuration/ios-sdk-config.md @@ -21,7 +21,7 @@ Make sure you have created a Project and iOS SDK KEY, otherwise refer to [Projec iOS SDK supports the following installation methods: -### Use CocoaPods +### CocoaPods QWeather iOS SDK can be installed via [CocoaPods](https://cocoapods.org/). CocoaPods is an open source dependency manager, if you haven't installed CocoaPods yet, please refer to [CocoaPods Getting Started guide](https://guides.cocoapods.org/using/getting-started.html). The following steps assume that you have already completed the installation and setup of CocoaPods. diff --git a/docs/_zh/account/developers.md b/docs/_zh/account/developers.md index 2f63602..b495564 100644 --- a/docs/_zh/account/developers.md +++ b/docs/_zh/account/developers.md @@ -17,7 +17,7 @@ ref: account-developers |增值税发票|增值税电子普通发票|增值税电子普通发票|增值税专用发票
增值税电子普通发票| |技术支持|工单|工单|工单、电子邮件| -## 注册开发者 +## 注册开发者 {#enroll-certified-developer} 注册开发者需要对你的帐号进行实名认证，访问[控制台-设置-用户信息](https://console-test.qweather.com/#/user/space)，在上方点击注册开发者。 @@ -52,7 +52,7 @@ ref: account-developers 最后点击“提交审核”按钮，进入审核流程。审核通过后，你的企业开发者信息将完成变更。 -## 取消开发者注册 +## 取消开发者注册 {#cancel-certified-developer} 一旦注册为开发者后，你无法主动取消。如果你不再使用和风天气开发服务，你可以删除你的帐号。 diff --git a/docs/_zh/account/inactive.md b/docs/_zh/account/inactive.md index 2e1530d..3555645 100644 --- a/docs/_zh/account/inactive.md +++ b/docs/_zh/account/inactive.md @@ -8,14 +8,14 @@ ref: account-inactive 因此，当用户长期未使用和风天气的产品时，我们将该用户帐号标记为“**闲置帐号**” ，所有**闲置帐号**将被从和风天气开发服务删除。 -## 什么是闲置 +## 什么是闲置 {#what-is-inactive} **闲置**指的是用户连续12个月： - 未登录过[开发控制台](https://console.qweather.com) - 未使用任何和风天气开发服务，包括创建了开发项目但是未发送任何请求 -## 闲置的后续情况 +## 闲置的后续情况 {#what-happens-when-your-account-is-inactive} 当用户满足上述闲置条件后，该帐号将被标记为**闲置帐号**，在此之前，和风天气会通过用户的注册电子邮件发送提醒通知。 @@ -23,7 +23,7 @@ ref: account-inactive 用户可以重新注册和风天气开发服务，但之前被删除的任何信息都将无法恢复。 -## 例外 +## 例外 {#exception} 如果用户的帐号符合下列一项或多项条件，即使用户的帐号满足了上述闲置的条件，也不会被视为闲置： diff --git a/docs/_zh/account/recipients.md b/docs/_zh/account/recipients.md index 2ee289b..b90a483 100644 --- a/docs/_zh/account/recipients.md +++ b/docs/_zh/account/recipients.md @@ -6,7 +6,7 @@ ref: account-contact 你可以为你的帐号添加多个通知接收人，这些接收人可以收到你帐号的所有通知。例如，你是帐号所有者，你希望在你的企业内其他人也能收到账单或服务到期提醒，这时你可以将他们添加到你的通知接收人中。 -## 添加通知接收人 +## 添加通知接收人 {#add-recipients} 访问[控制台-设置-通知](https://console.qweather.com/#/user/notice)，在下方可以看到你当前的所有通知接收人。如需要添加新的通知接收人，你只需要填写他的电子邮箱地址并点击“邀请”按钮。 @@ -14,7 +14,7 @@ ref: account-contact 如果被邀请人没有点击激活链接，或未收到邀请邮件，你可以稍等60分钟后重新发送。请注意，邀请邮件的有效期为24小时，如果超过24小时，邀请链接将失效。如果收到多封邀请邮件，以最新的一封邮件为准。 -## 删除通知接收人 +## 删除通知接收人 {#remove-recipients} 你可以从[控制台-设置-通知](https://console.qweather.com/#/user/notice)删除通知接收人，在需要删除的电子邮箱旁点击“删除”按钮即可。 @@ -23,6 +23,4 @@ ref: account-contact ## 限制 {#restriction} - 你最多可以添加5个通知联系人。 -- 所有涉及到帐号安全的通知不会发送给通知接收人，例如找回密码等。 - - +- 所有涉及到帐号安全的通知不会发送给通知接收人，例如找回密码等。 \ No newline at end of file diff --git a/docs/_zh/account/suspension.md b/docs/_zh/account/suspension.md index 44a9bcd..ec240db 100644 --- a/docs/_zh/account/suspension.md +++ b/docs/_zh/account/suspension.md @@ -6,14 +6,14 @@ ref: account-suspension 当你的行为违反了和风天气的[各项条款](/docs/terms/)，你的帐号可能将被冻结，冻结后你将无法操作你帐号中的大部分功能，并且和风天气保留对你的违规行为要求赔偿的权利，严重时你将面临法律风险。 -## 后果 +## 后果 {#consequences} - 冻结帐号无法使用和风天气所有开发服务，包括之前创建的项目，所有开发请求都将被拒绝。 - 冻结帐号内如有未到期订阅或未使用的可用额度，都将暂时无法使用。 - 控制台中的所有功能将无法使用，如因为欠款账单而造成的冻结，则除充值以外的功能无法使用。 - 已绑定的支付方式可能无法在其他正常帐号中使用。 -## 为什么冻结帐号 +## 为什么冻结帐号 {#why-accounts-are-suspended} 和风天气开发者服务的各项条款有助于全体用户获得公平服务，并保护用户与和风天气合作伙伴的权益，因此如果你的行为违反了这些条款，你的帐号可能会被冻结。 @@ -35,7 +35,7 @@ ref: account-suspension 在你提供给和风天气的帐号信息中存在虚假内容，例如错误的电子邮箱、身份信息等，在这种情况下我们会暂停你的帐号。请注意，虚假信息包含临时邮箱或临时电话号码。 -## 恢复和申诉 +## 恢复和申诉 {#restore-and-appeal} 对于因欠款账单而冻结的帐号，你可以登录控制台完成欠款账单的支付，即可恢复和风天气的服务。 diff --git a/docs/_zh/best-practices/cache.md b/docs/_zh/best-practices/cache.md index 2d94cd0..e42aa43 100644 --- a/docs/_zh/best-practices/cache.md +++ b/docs/_zh/best-practices/cache.md @@ -55,7 +55,7 @@ ref: bp-cache | 台风 | 活跃期 20分钟
非活跃期60分钟 | 10-60分钟 | | 太阳辐照 | 6小时 | 3-6小时 | -## 限制 +## 限制 {#restrictions} 你不能缓存、提取、批量存储GeoAPI中提供的所有数据，这将违反我们的[使用限制](/docs/terms/restriction/)和[服务条款](https://www.qweather.com/terms/developers-tos)。 diff --git a/docs/_zh/best-practices/protect-data-key.md b/docs/_zh/best-practices/protect-data-key.md index d751bf8..2b6398d 100644 --- a/docs/_zh/best-practices/protect-data-key.md +++ b/docs/_zh/best-practices/protect-data-key.md @@ -10,26 +10,26 @@ KEY是获取和风天气数据的重要敏感信息，你有责任妥善保管 从2014年开始，我们的API就支持了HTTPS加密访问，在2016年底，我们关闭了所有非HTTPS的访问。使用HTTPS可以有效的阻止请求中的敏感信息被泄露，请不要跳过HTTPS的保护。 -## 使用加密签名认证 +## 使用加密签名认证 {#signature-authentication} 使用[加密签名](/docs/resource/signature-auth/)的方式进行认证，这样即使他人抓取到了你的请求信息，也很难获得更多有价值的内容。 -## 为每个产品创建不同的KEY +## 为每个产品创建不同的KEY {#create-separate-key-for-each-product} 我们支持创建多个KEY和项目，因此不要把鸡蛋都放在一个篮子里，对于不同的产品或者同一产品的不同平台，应该创建不同KEY进行使用，例如你要做一个款关于旅游的项目，可以为iOS、Android、小程序和网站创建不同的KEY。 -## 更改KEY +## 更改KEY {#change-key} 如果你认为你的KEY已经泄露或者怀疑泄露，你可以新建一个KEY，然后升级你的程序，测试并确保程序都运行在新的KEY，最后删除旧的KEY。 -## 在服务端保存KEY +## 在服务端保存KEY {#store-key-on-the-server-side} 在服务端存储KEY，再通过服务端发送到前端需要展示的天气数据，这样他人就无法在前端中抓取到你的KEY。 -## 混淆或加密KEY +## 混淆或加密KEY {#encrypt-key} 如果不可避免的在前端中存储KEY，那么也可以通过混淆或加密代码的方式，再配合不定期的更改KEY，从而让他人获取这些数据更加困难。 -## 不要在代码中共享 +## 不要在代码中共享 {#do-not-share-with-others} 在开发过程中，不可避免的会与其他人共享你的代码，因此将KEY存储在环境变量或独立的文件中，则可以有效的避免代码共享时泄露你的KEY。如果你的代码会发布在公共源代码管理系统时（例如Github），请确保存储KEY的文件包含在`.gitignore`或其他类似功能的配置文件中，换句话说，让KEY不要保留在源代码管理系统中。 \ No newline at end of file diff --git a/docs/_zh/configuration/android-sdk-config.md b/docs/_zh/configuration/android-sdk-config.md index bbd30cc..4402f10 100644 --- a/docs/_zh/configuration/android-sdk-config.md +++ b/docs/_zh/configuration/android-sdk-config.md @@ -6,21 +6,21 @@ ref: config-android 这篇文档将介绍如何配置和风天气开发服务中的Android SDK。 -## 下载 +## 下载 {#download} |版本|日期|MD5|下载| |---|---|---|---| |{{ site.data.v.android.version }}|{{ site.data.v.android.date }}|{{ site.data.v.android.md5 }}|[下载]({{ site.data.v.android.dllink }})| -## 创建项目和KEY +## 创建项目和KEY {#create-project-and-key} 请确保你已经创建了一个Android SDK的KEY，否则请参考[项目和KEY](/docs/configuration/project-and-key/)。 -## 适配版本 +## 适配版本 {#os-requirement} Android 4.4+ -## 工程配置 +## 工程配置 {#project-configuration} 1. 解压文件，将文件夹内jar放入您的工程，并且引用 2. 配置Android Manifest 添加权限 @@ -58,7 +58,7 @@ Android 4.4+ -keep class com.qweather.sdk.** { *;} ``` -## 数据访问配置 +## 数据访问配置 {#data-access-configuration} **日志功能** diff --git a/docs/_zh/configuration/api-config.md b/docs/_zh/configuration/api-config.md index ec0d51a..f8afc1d 100644 --- a/docs/_zh/configuration/api-config.md +++ b/docs/_zh/configuration/api-config.md @@ -6,11 +6,11 @@ ref: config-api 在开始使用和风天气API服务之前，你需要进行一些简单的配置和准备工作。 -## 创建项目和KEY +## 创建项目和KEY {#create-project-and-key} 请确保已经创建了项目和Web API KEY，否则请参考[项目和KEY](/docs/configuration/project-and-key/)。 -## 了解API地址和参数 +## 了解API地址和参数 {#understanding-api-url} 通常来讲，一个完整的API请求URL由scheme，host，port，path和query parameters组成。（当然，在不同程序中可能叫法不一样，我们仅以[RFC 3986](https://www.rfc-editor.org/rfc/rfc3986)为参考） @@ -33,11 +33,11 @@ scheme host (port) path query parameters 对于大部分开发者来说，构建一个API URL并非难事，但我们仍然强烈建议你阅读[最佳实践-优化请求](/docs/best-practices/optimize-requests/)文档，了解发送API请求的一些常见问题和经验。 -## Gzip解压 +## Gzip 请注意，和风天气开发服务的API均使用Gzip进行了压缩，这将极大的减少网络流量，加快请求。因此，当你在开发过程中，需要对返回的数据进行解压。请参考[最佳实践-Gzip](/docs/best-practices/gzip/)。 -## 尝试一下 +## 尝试一下 {#try-it-out} 请复制并粘贴下列链接到你的浏览器中，看看返回了哪些内容。注意链接最后的参数`key`要换成你自己的KEY。 diff --git a/docs/_zh/configuration/ios-sdk-config.md b/docs/_zh/configuration/ios-sdk-config.md index 5269a3a..9e43045 100644 --- a/docs/_zh/configuration/ios-sdk-config.md +++ b/docs/_zh/configuration/ios-sdk-config.md @@ -14,15 +14,15 @@ ref: config-ios > **提示：**和风天气iOS SDK同样包含了macOS SDK。 -## 第1步: 创建项目和KEY +## 第1步: 创建项目和KEY {#step-1-create-project-and-key} 请确保你已经创建了一个iOS SDK的KEY，否则请参考[项目和KEY](/docs/configuration/project-and-key/)。 -## 第2步: 安装SDK +## 第2步: 安装SDK {#step-2-install-sdk} 和风天气iOS SDK支持下列安装方式： -### 使用CocoaPods +### CocoaPods {#cocoapods} 和风天气iOS SDK可以通过[CocoaPods](https://cocoapods.org/)进行安装。CocoaPods是一种开源依赖库管理器，如果你还未安装CocoaPods，请参考[CocoaPods快速开始](https://guides.cocoapods.org/using/getting-started.html)。下列步骤假设你已经完成了CocoaPods的安装和设置。 @@ -62,7 +62,7 @@ iOS SDK支持使用Swift Package Manager集成，具体步骤请参考[Adding pa * SDK URL: [https://github.com/qwd/iOS-SDK.git](https://github.com/qwd/iOS-SDK.git) * Dependency Rule: Up to Next Major Version 4.14.0 < 5.0.0 -### 手动安装 +### 手动安装 {#manual-install} 你可以选择手动安装和风天气iOS SDK。 @@ -93,11 +93,11 @@ iOS SDK支持使用Swift Package Manager集成，具体步骤请参考[Adding pa > ``` {:.bqwarning} -## 第3步: 配置密钥和订阅版本 +## 第3步: 配置密钥和订阅版本 {#step-3-setup-key-and-subscription} 在 `AppDelegate`文件中配置API密钥信息和选择订阅版本: -### 配置Public ID和KEY +### 配置Public ID和KEY {#setup-public-id-and-key} 将代码中的`Your_KEY`和`Your_Public_ID`替换为你项目中的KEY和Public ID @@ -106,7 +106,7 @@ QWeatherConfigInstance.publicID = @"Your_Public_ID"; QWeatherConfigInstance.appKey = @"Your_KEY"; ``` -### 配置项目的订阅版本 +### 配置项目的订阅版本 {#setup-subscription} - 标准订阅： @@ -119,7 +119,7 @@ QWeatherConfigInstance.appKey = @"Your_KEY"; QWeatherConfigInstance.appType = APP_TYPE_DEV; ``` -## 示例代码 +## 示例代码 {#sample-code} 在需要使用的地方加入以下代码输入所需参数即可，返回为对应类型的数据模型 diff --git a/docs/_zh/configuration/project-and-key.md b/docs/_zh/configuration/project-and-key.md index 5ee6eec..6560d6d 100644 --- a/docs/_zh/configuration/project-and-key.md +++ b/docs/_zh/configuration/project-and-key.md @@ -9,7 +9,7 @@ ref: config-project **KEY**是获取和风天气开发服务的密钥（或称之为token，认证信息），在创建项目后，你可以为你的不同业务和需求创建KEY，例如“iOS正式环境”或“测试专用”。 -## 创建项目 +## 创建项目 {#create-project} 1. 访问[控制台-项目管理](https://console.qweather.com/#/apps)，点击“创建项目”按钮。 2. 填写项目名称，项目名称最多20个字符。你可以稍后对名称进行修改。 @@ -18,7 +18,7 @@ ref: config-project 5. 填写KEY的名称，最多20个字符。 6. 点击“创建”按钮。 -## 创建KEY +## 创建KEY {#create-key} 当你创建一个项目的时候，已经要求创建一个KEY，如果需要创建更多的KEY： @@ -31,13 +31,13 @@ ref: config-project 4. 填写KEY的名称，最多20个字符。你可以稍后对名称进行修改。 5. 点击“创建”按钮。 -## 编辑项目和KEY +## 编辑项目和KEY {#edit-project-and-key} 你可以对项目和KEY的名称进行编辑，编辑名称不会影响你的开发服务，实时生效。 你也可以对iOS KEY的Bundle ID或Android KEY的Package Name进行编辑，可能需要一些时间才可生效，最长4小时，生效后原来绑定的Bundle ID或Package Name将无法再获取到数据。 -## 删除项目 +## 删除项目 {#delete-project} > **警告：**删除动作不可撤销，删除成功后，该项目及项目中的所有数据KEY都将被删除且无法恢复，你无法再通过这个项目中的KEY获取数据。 {:.bqdanger} @@ -46,7 +46,7 @@ ref: config-project 2. 点击“删除”按钮。 3. 在打开的确认窗口中再次确认是否删除，如果不希望删除，点击“取消”按钮，如果确定删除，请输入项目名称并点击“确认删除”按钮。 -## 删除KEY +## 删除KEY {#delete-key} > **警告：**删除动作不可撤销，删除成功后，你无法再通过这个KEY获取数据。 {:.bqdanger} diff --git a/docs/_zh/features/global-deployment.md b/docs/_zh/features/global-deployment.md index 7460507..1731b40 100644 --- a/docs/_zh/features/global-deployment.md +++ b/docs/_zh/features/global-deployment.md @@ -8,25 +8,25 @@ ref: feat-global 使用全球部署能力不需要你进行额外的配置，这一切几乎都是自动化的。 -## 多语言 +## 多语言 {#multi-language} 和风天气开发服务支持30+语言和本地语言，你只需要简单的在请求中添加多语言参数即可。 查看[我们支持的语言](/docs/resource/language/)。 -## 单位转换 +## 单位转换 {#unit-conversion} 和风天气开发服务提供公制单位和英制单位的选项，对于不同国家和地区的用户，你可以为他们设置合适的单位。 查看[单位](/docs/resource/unit/)。 -## 全球城市覆盖 +## 全球城市覆盖 {#global-city-coverage} 目前我们已经为全球超过20万个城市或地区提供气象服务，使用我们的地理信息服务，可以轻松的获取这些城市的信息。 查看[地理信息服务](/docs/api/geoapi/)。 -## 全球加速 +## 全球加速 {#global-acceleration} ![global-server](/assets/images/content/global-server-flow.png) diff --git a/docs/_zh/features/performance.md b/docs/_zh/features/performance.md index f6c634c..a809e72 100644 --- a/docs/_zh/features/performance.md +++ b/docs/_zh/features/performance.md @@ -6,7 +6,7 @@ ref: feat-performance 和风天气开发服务提供了稳定和高性能的服务保障，这使得你的开发没有后顾之忧。 -## 性能 +## 性能 {#performance} 和风天气开发服务可提供企业级性能的服务： diff --git a/docs/_zh/features/service-and-data.md b/docs/_zh/features/service-and-data.md index 322947c..92907ae 100644 --- a/docs/_zh/features/service-and-data.md +++ b/docs/_zh/features/service-and-data.md @@ -6,7 +6,7 @@ ref: feat-service 和风天气开发服务基于先进的气象和人工智能算法，为广大开发者和企业提供了丰富、精准的天气数据服务，帮助你在应用中展示天气，或助力你的业务决策。这一切都可以通过我们提供的开发工具，轻松的集成。 -## 服务 +## 服务 {#service} 和风天气开发服务提供下列开发服务： @@ -18,11 +18,11 @@ ref: feat-service 你可以通过上述服务在全球范围内，轻松快速的获取各类天气数据服务。 -## 数据 +## 数据 {#data} 我们支持中国（包括港澳台）及全球200+国家或地区的气象数据服务，城市或地区总数量超过20万个。 -### 天气类 +### 天气类 {#weather} | 数据项目 | 更新频率 | 时间颗粒度 | 时间范围 | 地理范围 | | -------------- | -------- | ---------- | --------- | -------- | @@ -36,7 +36,7 @@ ref: feat-service | 格点逐小时预报 | 1小时 | 逐小时 | 1-72小时 | 全球 | | 分钟级降水 | 5分钟 | 5分钟 | 1-2小时 | 中国 | -### 天气指数 +### 天气指数 {#weather-indices} | 数据项目 | 更新频率 | 时间颗粒度 | 时间范围 | 地理范围 | | -------------------- | -------- | ---------- | -------- | -------- | @@ -57,21 +57,21 @@ ref: feat-service | 交通指数 | 1小时 | 逐天 | 1-17天 | 中国 | | 防晒指数 | 1小时 | 逐天 | 1-18天 | 中国 | -### 空气类 +### 空气类 {#air-quality} | 数据项目 | 更新频率 | 时间颗粒度 | 时间范围 | 地理范围 | | ------------ | -------- | ---------- | -------- | -------- | | 空气质量实况 | 1小时 | 实时 | 实时 | 中国 | | 空气质量预报 | 1小时 | 逐天 | 1-5天 | 中国 | -### 预警类 +### 预警类 {#warning} | 数据项目 | 更新频率 | 时间颗粒度 | 时间范围 | 地理范围 | | ---------------- | -------- | ---------- | -------- | -------- | | 灾害预警 | 5分钟 | 实时 | 实时 | 中国，欧盟国家 | | 灾害预警城市列表 | 5分钟 | 实时 | 实时 | 中国，欧盟国家 | -### 天文类 +### 天文类 {#astronomy} | 数据项目 | 更新频率 | 时间颗粒度 | 时间范围 | 地理范围 | | ------------ | -------- | ------------ | -------- | -------- | @@ -79,14 +79,14 @@ ref: feat-service | 月升月落时间 | 24小时 | 逐天 | 1-60天 | 全球 | | 月相 | 24小时 | 逐天、逐小时 | 1-60天 | 全球 | -### 海洋类 +### 海洋类 {#ocean} | 数据项目 | 更新频率 | 时间颗粒度 | 时间范围 | 地理范围 | | -------- | -------- | ---------- | -------- | -------- | | 潮汐 | 24小时 | 逐天 | 1-3天 | 全球 | | 潮流 | 24小时 | 逐天 | 1-3天 | 全球 | -### 热带气旋（台风） +### 热带气旋（台风） {#tropical-cyclones} | 数据项目 | 更新频率 | 时间颗粒度 | 时间范围 | 地理范围 | | -------------- | -------- | ---------- | ------------ | -------- | diff --git a/docs/_zh/finance/billing-and-payment.md b/docs/_zh/finance/billing-and-payment.md index 3d68d42..b7ea204 100644 --- a/docs/_zh/finance/billing-and-payment.md +++ b/docs/_zh/finance/billing-and-payment.md @@ -53,13 +53,13 @@ ref: finance-billing 在9月再次获取了100万次城市实时天气，阶梯价格将重置，计算公式与上个月相同。 -### 如何降低成本？ +### 如何降低成本？ {#how-can-i-reduce-costs} 按量计费可以根据你的需求灵活的增加或减少请求量，避免提前预付大量金额。当你的请求量较多或需求较稳定的时候，你可以使用节省计费，大幅降低你的成本。参考[节省计划](/docs/finance/saving-plans/)。 对于有大量请求量的用户（通常指的是日均50万次请求以上），请与我们的商务专家联系，以便提供更佳的解决方案。 -### 当停止使用时，是否继续收费？ +### 当停止使用时，是否继续收费？ {#will-i-to-be-charged-when-i-stop-using} 按量计费的其中一个优势就是你可以随时开始或随时停止，在你停止使用后，你不会再收到任何账单，也无需支付费用。 @@ -97,7 +97,7 @@ ref: finance-billing 关于更多定期支付的说明，可以参考下方的[支付场景](#payment-scenarios)。 -### 手动支付 +### 手动支付 {#manual-payment} 你可以进行一次性手动付款，这将增加你的可用额度，用于支付订阅的账单或其他预付费服务。请参考[增加可用额度](#add-balance)。 @@ -163,7 +163,7 @@ ref: finance-billing > **警告：** 在“欠款”状态下，和风天气开发服务将被暂停，如“欠款”状态持续30天，你的帐号将被冻结。 {:.bqdanger} -### 退款 +### 退款 {#refund} 标准订阅和高级订阅采用后付费模式，因此你无法对已经使用的服务申请退款。 @@ -207,12 +207,12 @@ ref: finance-billing 提取可用额度需要支付**5%手续费**，提取的金额将退回到原支付渠道。如需要提取可用额度，请提交工单。 -## 增值税 +## 增值税 {#value-added-tax} 对于中国大陆地区用户的购买，账单金额已经包含了增值税。如需要获取增值税发票，参考[增值税发票](/docs/finance/vat-invoice/)。 对于其他国家或地区用户的购买，账单金额不包含所需要征收的任何税种。 -## 暂停和冻结 +## 暂停和冻结 {#suspension} 当帐单状态为欠款的时候，你的和风天气服务将被暂停，你需要尽快增加可用额度用于支付欠款帐单。当欠款帐单的状态持续30天后，你的帐号将被冻结并且你仍然需要支付欠款账单，请参考[帐号冻结](/docs/account/suspension/)。 diff --git a/docs/_zh/finance/pricing.md b/docs/_zh/finance/pricing.md index 375c532..77630b7 100644 --- a/docs/_zh/finance/pricing.md +++ b/docs/_zh/finance/pricing.md @@ -8,7 +8,7 @@ ref: finance-pricing 本文将介绍按量计费的定价和规则。 -## 计费标准 +## 计费标准 {#specifications} - **计价单位：**一次请求。参考[什么是一次请求](/help/#what-is-a-request)。 - **账单周期：**一个自然月 @@ -18,7 +18,7 @@ ref: finance-pricing > **例如：**用户每个月实时天气服务的请求量为100万次，那么该用户每个月标准订阅的成本为：(300000次请求 x 0.001元) + (700000次请求 x 0.0009元) = 930元 -## 定价 +## 定价 {#pricing} 按量计费是阶梯价计费，累进请求量是单一服务所包含的各项数据的请求量总和。 @@ -32,6 +32,6 @@ ref: finance-pricing {% include price-table.html %} -## 限制 +## 限制 {#restrictions} 按量计费定价仅支持标准订阅和高级订阅，免费订阅不需要支付费用也无法使用按量计费。 diff --git a/docs/_zh/finance/saving-plans.md b/docs/_zh/finance/saving-plans.md index 0675356..d83c728 100644 --- a/docs/_zh/finance/saving-plans.md +++ b/docs/_zh/finance/saving-plans.md @@ -31,11 +31,11 @@ ref: finance-splans | 1 年 | 0.6 | | 3 年 | 0.4 | -## 购买 +## 购买 {#purchase} 请访问**控制台-财务与费用-节省计划**，选择承诺的消费金额并购买。 -## 价格测算 +## 价格测算 {#price-calculator} 使用[价格计算器](https://console.qweather.com/#/calculator)可以快速的帮你计算所需要购买的节省计划。 @@ -59,34 +59,34 @@ ref: finance-splans |---|---| |在2022年12月30日23点，1000元的承诺金额使用完，从下一个小时开始的请求将不再享受节省计划折扣。
从2023年3月21日起，可以继续使用下一期的承诺金额1000元，以此类推。|在2023年3月20日23点59分59秒时，第一期的承诺金额还有剩余承诺金额234元，则从2023年3月21日起，剩余的234元将作废无法再使用。
从2023年3月21日起，可以继续使用下一期的承诺金额1000元，以此类推。| -## 生效 +## 生效 {#effective} 节省计划的生效时间为购买成功的当前小时。 > **例如：** 你在2022年3月20日14点30分成功购买了一份节省计划，则在2022年3月20日14点开始的所有数据请求，按照节省系数计算和扣款。 -## 折扣规则 +## 折扣规则 {#discount-rules} 节省计划按照对应节省系数进行计费，当节省计划过期或承诺金额消耗完毕后，不再享受折扣。 > **例如：** 购买承诺金额为1000元的节省计划（1年期），节省系数为0.6，此时实时天气的单次请求价格为：0.001元 x 0.6节省系数 = 0.006元。在一年内，如已使用超过1000元，则之后实时天气的单次请求价格为：0.001元。 -## 扣款顺序 +## 扣款顺序 {#payment-priority} 购买节省计划的之后，标准订阅账单将优先使用承诺金额，如果承诺金额已经使用完毕，则将从可用额度中扣款，为了避免出现欠款而造成的服务中止，我们建议你及时关注账单金额并确保足够的可用额度。 如果该用户购买了多份节省计划，参考多份节省计划的说明。 -## 多份节省计划 +## 多份节省计划 {#multiple-saving-plans} 你可以购买多份节省计划，可以叠加使用，以满足更加灵活的使用。多份节省计划，均按照购买时间先后顺序进行扣减。如果用户购买的是不同承诺期数的节省计划，则按不同的节省系数计算。 > **例如：**你在2022年3月20日购买了一份节省计划（3年期），并在5月31日又购买了一份节省计划（1年期），之后在10月25日第一份节省计划的承诺金额消耗完毕，那么在3月20日至10月25日之间将通过第一份节省计划进行标准订阅费用的支付，节省系数为0.4，在10月25日之后的节省系数为0.6，从2023年3月21日起，将继续使用第一份节省计划的承诺金额，节省系数为0.4。 -## 升降级和续费 +## 升降级和续费 {#upgrades-downgrades-and-renewals} 节省计划不支持升降级，但是你可以购买多份节省计划。如果在到期时需要对节省计划续费，只需要重新购买一份即可。 -## 取消节省计划 +## 取消节省计划 {#cancellation} 节省计划一旦购买，不支持取消和退款。如有特殊情况，请提交工单。 \ No newline at end of file diff --git a/docs/_zh/finance/vat-invoice.md b/docs/_zh/finance/vat-invoice.md index 96e7c46..da8d2e4 100644 --- a/docs/_zh/finance/vat-invoice.md +++ b/docs/_zh/finance/vat-invoice.md @@ -9,7 +9,7 @@ ref: finance-vat-invoice > **注意：**请认真阅读本篇文档，了解我们如何向你开具增值税发票、增值税发票的类型、开票时间以及开票限制，必要时请将本篇文档发送给你的财务人员查看。 {:.bqwarning} -## 申请流程 +## 申请流程 {#apply-introduction} 访问[控制台](https://console.qweather.com)： @@ -87,7 +87,7 @@ ref: finance-vat-invoice * 超过12个月的账单，无法申请发票。 * 增值税专用发票仅限[企业开发者](/docs/account/developers/)申请。 -## 其他 +## 其他 {#Other} 如果你对发票有其他问题，请与你的商务专员联系或提交工单。 diff --git a/docs/_zh/resource/icons.md b/docs/_zh/resource/icons.md index 539fd03..77f9cbf 100644 --- a/docs/_zh/resource/icons.md +++ b/docs/_zh/resource/icons.md @@ -10,7 +10,7 @@ ref: res-icons ![图标截图](/assets/images/content/qweather-icon-screenshot-new.png) -## 下载和使用 +## 下载和使用 {#download-and-usage} 你可以通过多种方式[下载和安装和风天气图标](https://icons.qweather.com/install/)，包括npm、CDN或直接下载。 @@ -18,7 +18,7 @@ ref: res-icons 访问[和风天气图标](https://icons.qweather.com)了解更多关于安装和使用的信息，并可以[浏览全部图标](https://icons.qweather.com/icons/)。 -## 源代码 +## 源代码 {#source-code} ``` git clone https://github.com/qwd/Icons.git @@ -31,7 +31,7 @@ git clone https://github.com/qwd/Icons.git > **注意：**图标和图标代码将不断的更新，包括新增、修改和删除，因此你必须对你的程序进行适配，以便在发生变化的时候不会导致错误出现！ {:.bqwarning} -### 天气图标 +### 天气图标 {#weather-icons} 一些天气状况会根据白天和晚上返回不同的图标，例如：白天的晴天将返回`100`（是一个太阳图标），夜间的晴天将返回`150`（是一个月亮图标）。 @@ -100,7 +100,7 @@ git clone https://github.com/qwd/Icons.git | 901 | 冷 | ✅ | ✅ | | 999 | 未知 | ✅ | ✅ | -### 月相图标 +### 月相图标 {#moon-phase-icons} 月相图标将自动适应南北半球的月相样式。例如今天的月相是上弦月，那么在北半球我们将返回`802`，而在南半球返回`806`。关于更多月相的说明请参考[月相](/docs/resource/sun-moon-info/#moon-phase)。 @@ -115,11 +115,11 @@ git clone https://github.com/qwd/Icons.git | 806 | 下弦月 | 上弦月 | | 807 | 残月 | 蛾眉月 | -### 预警图标 +### 预警图标 {#weather-warning-icons} 预警图标的代码和`warning.type`相对应，关于目前支持的`warning.type`请参考[预警类型](/docs/resource/warning-info/#warning-type)。 -## 版权和许可 +## 版权和许可 {#copyright-and-license} 版权所属 [QWeather](https://www.qweather.com/) @@ -127,7 +127,7 @@ git clone https://github.com/qwd/Icons.git 图标 [知识共享署名4.0](https://creativecommons.org/licenses/by/4.0/deed.zh) -## 早期版本 +## 早期版本 {#previous-versions} > **注意：**早期版本不再提供任何更新，有可能与目前最新的天气图标代码不匹配 {:.bqwarning} diff --git a/docs/_zh/resource/signature-auth.md b/docs/_zh/resource/signature-auth.md index c275f38..9982fc8 100644 --- a/docs/_zh/resource/signature-auth.md +++ b/docs/_zh/resource/signature-auth.md @@ -8,7 +8,7 @@ ref: res-auth 为了提供更安全的API认证，我们推荐你使用数字签名认证方式进行接口访问的认证，数字签名方式是一种替代单独API KEY的更安全的接口访问方式，它会对请求参数加密后得到的签名字串进行身份验证。 -## 签名参数 +## 签名参数 {#parameters} `publicid`: 公共ID，每个KEY都对应一个公共ID，可在[控制台](https://console.qweather.com)查看 @@ -18,7 +18,7 @@ ref: res-auth `以及其他接口必要参数` -## 创建签名 +## 创建签名 {#create-signature} 1. 将请求参数格式化为“key=value”格式，如“k1=v1”、“k2=v2”、“k3=v3”； 2. 去除请求参数中值为空的参数 diff --git a/docs/_zh/resource/sun-moon-info.md b/docs/_zh/resource/sun-moon-info.md index 009b3d9..680092f 100644 --- a/docs/_zh/resource/sun-moon-info.md +++ b/docs/_zh/resource/sun-moon-info.md @@ -22,7 +22,7 @@ ref: res-sunmoon 月升月落的时间更加复杂和多变，我们列举了一些常见场景。 -### 为什么月亮在早上升起？ +### 为什么月亮在早上升起？ {#why-does-the-moon-rise-in-the-morning} 为什么有时候月升的时间是上午9点？月亮不是只在晚上出现吗？你们的数据出错了吧？ @@ -46,7 +46,7 @@ ref: res-sunmoon > **提示：**上述计算和数据仅为举例说明，并非严谨计算。实际上每天的月升时间相比前一天可能推迟30-70分钟。 -### 为什么一整天都有月亮？ +### 为什么一整天都有月亮？ {#why-is-there-a-moon-all-day-long} 由于月球的公转轨道不是地球的赤道平面，而是比较接近黄道平面，你可以理解为月亮是倾斜着围绕地球进行公转，因此在高纬度地区，每个月至少有一天完全看不到月亮，也至少有一天月亮在一整天都出现，此时`moonrise` 和 `moonset`可能为空。 @@ -54,7 +54,7 @@ ref: res-sunmoon *地球和月球轨道（原始图片[Wikimedia](https://commons.wikimedia.org/wiki/File:Earth-Moon-zh-Hant.PNG)）* {:.figimg} -### 只有月升或只有月落 +### 只有月升或只有月落 {#only-moonrise-or-moonset} 还记得上边我们说到每天月升时间都会比前一天晚50分钟吗？所以当一个特定日期的月升时间在23:10-23:59分时，那么下一次的月升则会推迟到第三天的00:00-00:49，月落也是如此。因此通常情况下，每个月都会有一天只有月升，有一天只有月落，并且一般发生在上弦月和下弦月的前后。 diff --git a/docs/_zh/resource/unit.md b/docs/_zh/resource/unit.md index 15a4ab0..4b5f951 100644 --- a/docs/_zh/resource/unit.md +++ b/docs/_zh/resource/unit.md @@ -9,14 +9,14 @@ ref: res-unit 和风天气默认采用公制单位，例如：公里、摄氏度等，如需要采用英制单位，可以通过添加对应的参数进行设置。 -## 单位参数 +## 单位参数 {#unit-parameters} | 单位 | API请求参数 | iOS常量属性 | Android常量属性 | | -------- | ------- | ----------- | --------------- | | 公制单位 | m | UNIT_TYPE_M | METRIC | | 英制单位 | i | UNIT_TYPE_I | IMPERIAL | -## 单位列表 +## 单位列表 {#unit-information} > 有一些数据项不存在英制单位的，统一使用公制单位。 diff --git a/docs/_zh/resource/wind-info.md b/docs/_zh/resource/wind-info.md index a14e134..76bcb7c 100644 --- a/docs/_zh/resource/wind-info.md +++ b/docs/_zh/resource/wind-info.md @@ -13,7 +13,7 @@ ref: res-wind 风向角度以正北为0°，顺时针旋转360度。风向方位通常采用16个方位，即将360°平分为16份，正北=0°（360°），正东=90°，正南=180°，正西=270°。我国一般采用8个方位来预报风向[^1]，因此对于中国地区的城市，我们仅提供8个方位的风向方位数值，在中国以外的城市和全部格点化数据中继续采用16方位。如果你希望在中国城市也使用16方位，可以通过风向角度进行换算。 -### 16位风向方位 +### 16位风向方位 {#16-wind-directions} ![风向16方位图](/assets/images/content/wind-direction-rose.png) *风向16方位图。(图片由QWeather创作并基于[CC BY 4.0许可](https://creativecommons.org/licenses/by/4.0/deed.zh)发布，下载[原图](https://github.com/qwd/dev-site/raw/master/assets/images/content/wind-direction-rose.png))* @@ -40,7 +40,7 @@ ref: res-wind | 西北风 | NW | 315 | 303.75 - 326.25 | | 西北偏北风 | NNW | 337.5 | 326.25 - 348.75 | -### 中国8位风向方位 +### 中国8位风向方位 {#8-wind-directions} 适用于中国城市天气数据的8位风向方位和特殊值如下： @@ -78,7 +78,7 @@ ref: res-wind 其中`V`是海平面以上10米处的等效风速，`B`是蒲福级数。例如，B = 9.5 与 24.5 m/s 相关，等于“蒲福风级10级”的下限。 -### 风级的对应关系 +### 风级的对应关系 {#scale-description} #### 标准蒲福风级0-12 diff --git a/docs/_zh/start.md b/docs/_zh/start.md index 7af7265..ac070e7 100644 --- a/docs/_zh/start.md +++ b/docs/_zh/start.md @@ -8,7 +8,7 @@ ref: start-overview 欢迎使用和风天气开发服务，本篇文档将介绍一些入门步骤和基本概念，便于你快速开始以及了解和风天气开发服务是如何运行的。 -## 快速开始 +## 快速开始 {#getting-started} #### 第一步 注册帐号 @@ -42,7 +42,7 @@ https://api.qweather.com/v7/weather/now?location=101010100&key=你的KEY 参考[开发文档](/docs/api/)获取更多数据。 -## 费用 +## 费用 {#cost} 当你使用标准订阅或高级订阅时，根据你的请求量，你需要支付订阅费用。 @@ -52,7 +52,7 @@ https://api.qweather.com/v7/weather/now?location=101010100&key=你的KEY 对于中国大陆地区的用户，我们的价格已经包含增值税，如需要开具增值税发票请参考[增值税发票](/docs/finance/vat-invoice/)。 -## 更多资料 +## 更多资料 {#more-resources} 在开发过程中，这些实用资料可以帮助你更高效的完成工作。 diff --git a/docs/_zh/terms/attribution.md b/docs/_zh/terms/attribution.md index 2f80ee5..2d79e93 100644 --- a/docs/_zh/terms/attribution.md +++ b/docs/_zh/terms/attribution.md @@ -8,7 +8,7 @@ ref: terms-attribution 对于不同的数据，请根据下方规范注明来源： -## 注明来源 +## 注明来源 {#attribution-requirements} 如果在你的产品中（例如APP、网站等）使用了和风天气开发服务，你需要清晰的展示我们的名字：`和风天气`或`QWeather`，并添加超级链`https://www.qweather.com`。我们推荐： @@ -26,7 +26,7 @@ ref: terms-attribution 你必须在使用了空气质量的产品中完整的显示`refer.sources`的所有内容，并且不能以任何形式修改此内容。 -## 样式要求 +## 样式要求 {#attribution-style} 在显示来源的样式上，我们没有明确的要求，优先以你的产品样式确定，但请遵循下列指导： @@ -34,6 +34,6 @@ ref: terms-attribution - **不易混淆：**来源应该是单独放置的，而不是与你产品的内容混为一体的，或容易引起误解的。例如“天气服务由和风天气驱动”不应该出现在网页正文的某一个段落里，或紧挨着一则广告（避免被误解为该广告由来源方提供）。 - **非冒犯性：**在注明来源的上下文中，不能出现冒犯性或容易引起反感或对来源方产生负面影响的内容。 -## 例外 - +## 例外 {#exceptions +} 如果你使用的是我们单独提供的商业许可授权，可能不适用本文档的约定，或者如果你的产品在特殊设备上无法显示来源字样，请与我们联系，以便讨论此类特例情况的处理方式。 \ No newline at end of file diff --git a/docs/_zh/terms/license.md b/docs/_zh/terms/license.md index adb5e7e..8305cbb 100644 --- a/docs/_zh/terms/license.md +++ b/docs/_zh/terms/license.md @@ -8,11 +8,11 @@ ref: terms-license > **提示：**在你遵守下列许可证的要求下，这些许可证均赋予你更多自由的权利，以及适用于任何用途（包括商业用途）。然而除和风开发许可证以外，我们无法针对其他许可证给出更多建议或解释，请访问各个许可证的链接查看原文，或与你的法律顾问进行讨论。 -## 和风开发许可证 +## 和风开发许可证 {#qweather-developers-license} 当你使用[标准订阅](/docs/finance/subscription/#standard-subscription)时，将使用[和风开发者许可协议](https://www.qweather.com/terms/developers-eula)。 -## 署名-相同方式共享 4.0 国际 (CC BY-SA 4.0) +## 署名-相同方式共享 4.0 国际 (CC BY-SA 4.0) {#attribution-sharealike-40-cc-by-sa-40} 当你使用[免费订阅](/docs/finance/subscription/#free-subscription)时，除[地理信息数据](/docs/api/geoapi/)以外的数据和服务将使用[CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/deed.zh)许可证。 diff --git a/docs/_zh/terms/restriction.md b/docs/_zh/terms/restriction.md index 86ddbf9..29148d8 100644 --- a/docs/_zh/terms/restriction.md +++ b/docs/_zh/terms/restriction.md @@ -6,37 +6,37 @@ ref: terms-restriction 为了让开发者更加公平、合规的使用和风天气服务，你需要同意我们的各项服务条款和限制。在本篇文档，我们将罗列一些常见的使用限制和解释说明，便与你更好的理解这些条款和限制。 -## 不合规的产品 +## 不合规的产品 {#non-compliant-products} 你的产品（例如APP或网站等）使用了和风天气的所有服务，该产品必须符合中国法律法规的规定并符合公序良俗，否则你的帐号将被冻结。 参考[开发者服务条款4.1条款](https://www.qweather.com/terms/developers-tos)。 -## 非正常请求 +## 非正常请求 {#invalid-requests} 当你收到返回数据不是`code=2xx`时，你应该检查你的程序，因为这代表了错误的请求。对于所有错误的请求，如超过合理范围，将被视为对我们服务的攻击，此时你可能无法再继续使用和风天气开发服务或你的帐号将被冻结。 参考[优化请求](/docs/best-practices/optimize-requests/)和[开发者服务条款4.7条款](https://www.qweather.com/terms/developers-tos)。 -## 欠款 +## 欠款 {#outstanding} 和风天气开发服务的标准订阅采用按量计费后付费模式，你应该按照账单金额支付费用。当账单欠款超过30天的，你的帐号将被冻结，并且我们保留包括采取法律行动等方式继续向你追缴欠款的权利。 参考[账单和计费系统](/docs/finance/billing-and-payment/)。 -## 未注明来源 +## 未注明来源 {#no-attribution} 根据我们的许可和数据源版权要求，你必须在使用了和风天气开发服务的产品中注明来源，否则你可能无法继续使用和风天气任何服务。 参考[注明来源](/docs/terms/attribution/)。 -## 缓存或索引地理信息数据 +## 缓存或索引地理信息数据 {#cache-or-index-geoapi-data} 由于地理信息版权方要求以及版权许可限制，当你使用和风天气开发服务中的[地理信息服务](/docs/api/geoapi/)时，你不能批量缓存或下载这些数据，也不允许通过保存这些地理数据建立索引，否则你将侵犯数据源版权或面临法律风险。 参考[开发者许可协议](https://www.qweather.com/terms/developers-eula)。 -## 帐号冻结 +## 帐号冻结 {#account-suspension} 当你的帐号被冻结后，你无法使用到任何和风天气开发服务，并且你的支付方式和帐号信息也无法在新的帐号中使用。根据你的违规严重情况，我们有权将你的信息提交给具有管辖权的司法机构。 diff --git a/pages/en/help.md b/pages/en/help.md index e13285c..2c8a325 100644 --- a/pages/en/help.md +++ b/pages/en/help.md @@ -33,7 +33,7 @@ Yes, based on QWeather's global data center and CDN edge acceleration capabiliti ## Development -### 204/400/401/402/403/404/429 status code +### Status code 204/400/401/402/403/404/429 When the above status code is retrieved, it means there may be some issues with your request, refer to [Status Code](/en/docs/resource/status-code/). @@ -75,7 +75,7 @@ Please contact your business manager. ### Is there any sample code? -Please refer to the examples in the development guide or [showcase](/en/showcase/) and [best-practices](/en/docs/best-practices/). +Please refer to the examples in the [development guide](/en/docs/api/) or [showcase](/en/showcase/) and [best-practices](/en/docs/best-practices/). ### More development questions diff --git a/pages/zh/help.md b/pages/zh/help.md index 8654226..9a80055 100644 --- a/pages/zh/help.md +++ b/pages/zh/help.md @@ -8,19 +8,19 @@ ref: faq ## 一般问题 {#general} -### 什么是和风天气开发服务？ +### 什么是和风天气开发服务？ {#what-is-qweather-develop-service} 和风天气开发服务是一项轻松、低成本和开发友好的气象数据开发服务，你可以非常简单的将所需的天气数据植入你的产品，也可以通过丰富的天气数据提供对你业务的决策。 -### 什么是控制台？ +### 什么是控制台？ {#what-is-the-console} 控制台是和风天气开发服务的管理平台，你可以在控制台内进行项目、财务、统计和用户的管理。 -### 如何快速开始使用和风天气开发服务？ +### 如何快速开始使用和风天气开发服务？ {#how-to-get-started-quickly-with-qweather-services} 使用和风天气开发服务很简答，请参考[快速开始](/docs/start/)。 -### 和风天气服务覆盖了哪些国家和地区？ +### 和风天气服务覆盖了哪些国家和地区？ {#what-countries-and-regions-are-covered-by-the-qweather-service} 对于不同的数据，覆盖范围有所不同。对于天气数据，我们支持全球200+国家和地区；对于预警数据，参考[预警信息-支持的国家或地区](/docs/resource/warning-info/#supported-regions)；对于分钟降水和空气质量，支持中国内地。 @@ -28,69 +28,69 @@ ref: faq 所有用户都可以使用[免费订阅](/docs/finance/subscription)免费获取我们的部分天气服务。对于免费订阅不支持的服务，你可以少量充值进行测试。 -### 在世界各地都可以使用天气服务吗？ +### 在世界各地都可以使用天气服务吗？ {#is-the-qweather-service-available-anywhere-in-the-world} 是的，基于和风天气全球各国的数据中心和CDN边缘加速能力，你可以在世界任何地方使用我们的天气服务。了解[全球部署](/docs/features/global-deployment/)和[服务性能](/docs/features/performance/)。 ## 开发和技术 {#development} -### 出现204/400/401/402/403/404/429状态码 +### 出现204/400/401/402/403/404/429状态码 {#status-code-204400401402403404429} 当出现上述状态码时，代表你的请求可能出现了一些问题，请参考[错误状态码](/docs/resource/status-code/)。 -### 获取到的数据是乱码 +### 获取到的数据是乱码 {#the-data-is-garbled} 我们的API采用了Gzip压缩，这将极大减少你的网络流量，因此你需要对获取的数据进行Gzip解压。参考[处理Gzip](/docs/best-practices/gzip/)。 -### 免费订阅的API地址是什么？ +### 免费订阅的API地址是什么？ {#what-is-the-api-url-for-free-subscription} 免费订阅的API地址是`devapi.qweather.com`，更多免费订阅的配置请参考[API配置](/docs/configuration/api-config/)，[iOS配置](/docs/configuration/ios-sdk-config/)和[Android配置](/docs/configuration/android-sdk-config/)。 -### 免费订阅请求量用完了会发生什么? +### 免费订阅请求量用完了会发生什么？ {#what-happens-when-i-run-out-of-free-subscription-requests} 你会收到`402`错误代码。此时你将无法再使用免费订阅请求我们的服务，在每天0点（北京时间），免费订阅的请求量将会重置。请注意，当你收到任何非2xx代码的时候，不要无限制的进行重试，这可能会触发使用限制和违反我们的服务条款而导致帐号冻结。参考[使用限制](/docs/terms/restriction/)。 -### 我能否缓存数据？ +### 我能否缓存数据？ {#can-i-cache-data} 除地理信息数据以外，可以。你可以参考[缓存数据](/docs/best-practices/cache/)这篇文档，介绍了一些关于缓存数据的经验。但是对于地理信息数据，由于版权限制，你不能进行任何形式的缓存或创建索引。 -### 从哪里可以获得城市列表？ +### 从哪里可以获得城市列表？ {#where-can-i-get-a-list-of-cities} 我们提供中国地区的城市列表，请参考[常见城市列表](/docs/resource/location-list/)。对于全球其他国家和地区，已支持超过50万个城市，但由于版权原因，无法提供完整的城市数据库。 城市数据会根据政府规划或其他原因而变更，建议使用[地理信息服务](/docs/api/geoapi/)获取实时城市信息。 -### 是否支持天气图标？ +### 是否支持天气图标？ {#do-you-have-weather-icons} 我们的工程师提供了一套开源的天气图标，支持天气状态、月相和天气预警。天气图标是SVG格式，因此你可以自行修改颜色或样式。访问[天气图标代码文档](/docs/resource/icons/)和[天气图标](https://icons.qweather.com/)。 -### 天气状态的枚举值是什么？ +### 天气状态的枚举值是什么？ {#what-is-the-enum-value-of-the-weather-condition} 请参考`icon`字段以及[天气图标代码文档](/docs/resource/icons/)。 -### 你们的TLS版本是什么？ +### 你们的TLS版本是什么？ {#what-is-your-tls-version} 我们支持TLS 1.0及后续版本。 -### 能否批量获取数据？ +### 能否批量获取数据？ {#is-it-possible-to-get-data-in-bulk} 请与你的商务客服联系。 -### 有没有示例代码？ +### 有没有示例代码？ {#is-there-any-sample-code} -请参考开发文档中的示例，或[作品展示](/showcase/)和[最佳实践](/docs/best-practices/)。 +请参考[开发文档](/docs/api/)中的示例，或[作品展示](/showcase/)和[最佳实践](/docs/best-practices/)。 -### 其他开发和技术问题 +### 其他开发和技术问题 {#more-development-questions} 绝大多数开发问题都可以在文档中找到答案，例如[开始使用](/docs/start/)，[最佳实践](/docs/best-practices/)，[实用资料](/docs/resource/)以及对应数据的开发文档。如果不能解决你的问题，请登录[控制台](https://console.qweather.com)向我们提交工单。 ## 授权许可 {#license} -### 我可以将和风天气服务用于商业用途吗？ +### 我可以将和风天气服务用于商业用途吗？ {#can-i-use-the-qweather-service-for-commercial-purposes} 可以。使用免费订阅、标准订阅和高级订阅，只需满足许可证条件，即可用于任何用途，包括商业用途。了解[许可证](/docs/terms/license/)。 -### 是否需要注明来源？ +### 是否需要注明来源？ {#is-attribution-required} 是的。无论何种许可证，你都必须根据要求注明来源以及包括一些数据源的声明，这将让你避免版权风险以及符合合规性要求。请参考[注明来源](/docs/terms/attribution/)。 @@ -100,19 +100,19 @@ ref: faq 和风天气开发服务的标准订阅采用按量计费的定价模式，不需要提前预付大量资金，也不需要为用不到的服务买单，你只需要为你实际使用的部分付费即可。当你停止使用的时候，你不需要再支付任何费用。另外，按量计费的定价是阶梯价格，意味着你使用的越多，单价越低。请参考[按量计费定价](/docs/finance/pricing/)和[账单系统](/docs/finance/billing-and-payment/)。 -### 什么是订阅？ +### 什么是订阅？ {#what-is-subscription} 订阅是一种服务模式，类似于你订阅了一份报纸或杂志，在订阅期你都可以持续的使用服务。现在，和风天气服务采用订阅的方式，提供免费订阅、标准订阅和高级订阅。参考[订阅](/docs/finance/subscription/)。 -### 账单是什么？ +### 账单是什么？ {#what-is-billing} 账单是和风天气计费系统的核心，所有计费项目都将整合进帐单，用户根据帐单金额进行支付。账单同样是你和我们之间的具有法律效力的凭证，我们将根据账单内容向你提供服务并根据账单金额向你收取费用。请参考[账单与支付](/docs/finance/billing-and-payment/)。 -### 什么是节省计划？ +### 什么是节省计划？ {#what-is-savings-plan} 节省计划用于抵扣标准订阅产生的费用，是针对数据请求量较多和较稳定的用户所推出的一项折扣计划，它不依赖于具体的数据，只需要用户承诺每年的消费金额就可以获取大量折扣。相比较标准按量计费，节省计划可以节省40%-70%的成本。参考[节省计划](/docs/finance/saving-plans/)。 -### 如何预估成本？ +### 如何预估成本？ {#how-to-estimate-the-cost} 请登录控制台，使用[价格计算器](https://console.qweather.com/#/calculator)估算你的成本。 @@ -124,15 +124,15 @@ ref: faq 当你通过API、SDK或其他方式访问我们的服务并获得数据的行为称之为数据请求。一次请求无论获取多少内容，均算一次请求。如果请求返回的状态码非`2xx`，则不计算请求次数，但是超过合理范围的错误请求，将被冻结帐号。 -### 如何查询统计？ +### 如何查询统计？ {#how-to-check-statistics} 请访问[控制台-数据统计](https://console.qweather.com/#/statistics)。我们提供依据项目或数据的最近24小时（逐小时）、最近30天（逐天）和最近6个月（逐月）的请求量统计。如需要更详细的统计信息，建议你在产品中进行自行统计。 -### 支持哪些付款方式？ +### 支持哪些付款方式？ {#what-payment-methods-are-supported} 对于所有用户，我们都支持在线支付（支付宝）。对于[企业开发者](/docs/account/developers/)，我们还支持对公转账。关于更多支付的信息，请参考[账单与支付](/docs/finance/billing-and-payment/)。 -### 退款或提取可用额度 +### 退款或提取可用额度 {#refunds-or-withdraw-balance} 对于购买的预付费产品，例如节省计划或资源包，在购买不足7天且未开始使用的情况下，我们支持无条件退款，退款需要收取5%手续费。 @@ -142,43 +142,43 @@ ref: faq 是的。对于中国地区的用户，我们的价格均已包含增值税。参考[增值税发票](/docs/finance/vat-invoice/)。 -### 能否开具增值税发票？ +### 能否开具增值税发票？ {#can-you-issue-vat-invoices} 可以。对于中国地区的注册用户和个人开发者，我们支持开具增值税电子普通发票；对于中国地区的企业开发者，我们支持开具增值税电子普通发票和增值税专用发票。对于充值的金额，需要在完成消费后才可开具增值税发票。参考[增值税发票](/docs/finance/vat-invoice/)。 -### 我需要一份订单或协议 +### 我需要一份订单或协议 {#i-need-a-contract} 我们提供电子账单用于你的消费凭证。你可以设置账单的联系方式和语言，账单是你和我们之间的合法凭证，由系统自动生成，因此不需要盖章或签字。参考[账单与支付](/docs/finance/billing-and-payment/)。 ## 帐号管理 {#account-management} -### 如何更改帐号信息？ +### 如何更改帐号信息？ {#how-to-change-the-account-information} 你可以修改帐号联系方式和密码，请参考[帐号管理](/docs/account/)。 -### 如何删除我的帐号？ +### 如何删除我的帐号？ {#how-do-i-delete-my-account} 请访问[和风天气用户中心](https://id.qweather.com/)进行安全的删除。请注意，删除帐号不可恢复，包括你在使用和风天气的其他服务（例如和风天气APP、插件、可视化地图）都将被停止。参考[删除帐号](/docs/account/management/#delete-account)。 -### 我的帐号被冻结了 +### 我的帐号被冻结了 {#my-account-has-been-suspended} 请参考[帐号冻结](/docs/account/suspension/)。 -### 我能添加更多联系人以便收到服务通知吗？ +### 我能添加更多联系人以便收到服务通知吗？ {#can-i-add-more-contacts-to-receive-service-notifications} 可以。请访问控制台-设置-通知联系人，你可以为你的帐号最多添加5个通知联系人，他将收到所有相关通知的电子邮件（安全信息除外，例如验证码等）。参考[通知接收人](/docs/account/recipients/)。 -### 我忘记了注册邮箱和手机号码 +### 我忘记了注册邮箱和手机号码 {#lost-registration-information-and-password} 请参考[忘记了注册信息和密码](/docs/account/management/#lost-registration-information-and-password)。 -### 如何变更开发者身份？ +### 如何变更开发者身份？ {#how-to-modify-developer-identification} 个人开发者可以变更为企业开发者，企业开发者可以变更企业信息，参考[修改开发信息](/docs/account/developers/#modify-developers)。 -## 法律条款 +## 法律条款 {#legal-terms} -### 我能做什么和不能做什么 +### 我能做什么和不能做什么 {#what-i-can-and-cannot-do} 为了提供一个公平的环境以及保护你的权利，你需要了解和遵守我们的各项服务条款。参考[条款](/docs/terms/)。