Apifox 帮助文档
帮助文档常见问题Apifox 官网私有化部署
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
帮助文档常见问题Apifox 官网私有化部署
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
  1. 服务与隐私协议
  • 帮助中心
  • 更新日志
  • 入门
    • 产品介绍
    • 联系我们
    • 私有化部署
  • 开始使用
    • 下载 Apifox
    • 注册与登录
    • 页面布局
    • 基本概念
    • 快速上手
      • 概述
      • 新建接口
      • 发送接口请求
      • 快捷请求
      • 添加断言
      • 新建测试场景
      • 分享 API 文档
      • 了解更多
    • 基础知识
      • 接口基本信息
        • 请求 URL 与方法
        • 请求参数与请求体
        • 请求头
        • 请求参数编码解码
        • HTTP/2
      • 认证与授权
        • 概述
        • 支持的授权类型
        • Digest Auth
        • OAuth 1.0
        • OAuth 2.0
        • Hawk Authentication
        • Kerberos
        • NTLM
        • Akamai EdgeGrid
        • CA 和客户端证书
      • 响应与 Cookie
        • 概述
        • API 响应
        • 创建和发送 Cookie
        • 实际请求
        • 提取响应示例
      • 请求代理
        • 网页端中的请求代理
        • 分享文档中的请求代理
        • 客户端中的请求代理
      • API Hub
        • API Hub
    • 导入导出数据
      • 概述
      • 手动导入
      • 定时导入
      • 导入设置
      • 导出数据
      • 其它方式导入
        • 导入 OpenAPI/Swagger
        • 导入 Postman
        • 导入 Apipost
        • 导入 Eolink
        • 导入 cURL
        • 导入 Markdown
        • 导入 Insomnia
        • 导入 apiDoc
        • 导入 .har 文件
        • 导入 knife4j
        • 导入 NEI
        • 导入小幺鸡(docway)
        • 导入 Apizza
        • 导入 WSDL
  • 设计 API
    • 概述
    • 新建 API 项目
    • 接口基础知识
    • 请求体多示例配置
    • 响应组件
    • 常用字段
    • 全局参数
    • 历史记录
    • 批量管理
    • 数据模型
      • 概述
      • 新建数据模型
      • 通过 JSON 等生成
      • 高级数据类型
      • 构建数据模型
    • 鉴权组件
      • 概述
      • 创建鉴权组件
      • 使用鉴权组件
      • 在线文档中的鉴权组件
    • 高级功能
      • 接口字段
      • 接口状态
      • 关联测试场景
      • 参数列表外观
      • 接口唯一标识
  • 开发和调试 API
    • 概述
    • 生成请求
    • 发送请求
    • 请求历史
    • 接口用例
    • 动态值
    • 校验响应
    • 文档模式/调试模式
    • 生成代码
    • 环境和变量
      • 概述
      • 全局/环境/临时变量
      • 环境与服务
      • Vault Secrets(密钥库)
        • 功能简介
    • 前后置操作&脚本
      • 概述
      • 断言
      • 提取变量
      • 等待时间
      • 数据库操作
        • 概述
        • MongoDB
        • Redis
        • Oracle
      • 使用脚本
        • 概述
        • 前置脚本
        • 后置脚本
        • 公共脚本
        • pm 脚本 API
        • 使用 JS 类库
        • 响应数据可视化
        • 调用外部程序
      • 脚本示例
        • 断言示例
        • 脚本使用变量
        • 脚本读取/修改接口请求信息
      • 常见问题
        • 如何获取动态参数的真实值并加密?
        • 脚本运行后,提取的数字(bigint)精度丢失应该如何处理?
    • API 调试
      • GraphQL 调试
      • WebSocket 调试
      • Socket.IO 调试
      • SSE 调试
      • SOAP/WebService
      • gRPC 调试
      • 使用请求代理调试
      • Dubbo 调试
        • 新建 Dubbo 接口
        • 调试 Dubbo 接口
        • Dubbo 接口文档
      • TCP(Socket)
        • Socket 接口功能简介
        • 报文数据处理器
  • Mock 数据
    • 概述
    • 智能 Mock
    • 自定义 Mock
    • Mock 优先级
    • Mock 脚本
    • 云端 Mock
    • 自托管 Runner Mock
  • 自动化测试
    • 概述
    • 编排测试场景
      • 新建测试场景
      • 测试步骤间传递数据
      • 测试流程控制条件
      • 从接口/用例同步数据
      • 跨项目导入接口/用例
      • 导出测试场景数据
    • 运行测试场景
      • 运行测试场景
      • 批量运行测试场景
      • 数据驱动测试
      • 定时任务
      • 管理其它项目接口的运行环境
    • 测试报告
      • 测试报告
    • API 测试
      • 集成测试
      • 性能测试
      • 端到端测试
      • 回归测试
    • Apifox CLI
      • 概述
      • 安装和运行 CLI
      • CLI 命令选项
    • CI/CD
      • 概述
      • 与 Jenkins 集成
      • 与 Gitlab 集成
      • 与 Github Actions 集成
      • 与其它更多 CI/CD 平台集成
  • 发布 API 文档
    • 概述
    • 快捷分享
    • 查看 API 文档
    • 发布文档站
    • 页面布局设置
    • 自定义域名
    • AI 相关特性
    • 高级设置
      • 文档站搜索设置
      • 跨域代理
      • 文档站接入 Google Analytics
      • SEO 设置
      • 文档左侧目录设置
      • 文档可见性设置
      • 在线 URL 链接规范
    • API 版本
      • 创建 API 版本
      • 发布 API 版本
      • 快捷分享 API 版本
      • 功能简介
  • 迭代分支
    • 功能简介
    • 新建迭代分支
    • 在迭代分支中改动 API
    • 在迭代分支中测试 API
    • 合并迭代分支
    • 管理迭代分支
  • 管理中心
    • 入驻清单
      • 了解基本概念
      • 团队入驻
    • 管理团队
      • 团队基本操作
      • 团队成员管理
      • 成员角色与权限设置
      • 团队资源
        • 通用 Runner
        • 请求代理 Agent
        • 团队变量
      • 实时协作
        • 团队协作
    • 管理项目
      • 项目基本操作
      • 项目成员管理
      • 通知设置
        • 功能简介
        • 通知对象
        • 通知事件
      • 项目资源
        • 数据库连接
    • 管理组织
      • 单点登录(SSO)
        • 功能简介
        • 为组织配置单点登录
        • 管理用户账号
        • 将组映射到团队
        • Microsoft Entra ID
      • SCIM 用户管理
        • 功能简介
        • Microsoft Entra ID
      • 组织资源
        • 自托管 Runner
  • IDEA 插件
    • 快速上手
    • 生成接口文档
    • 生成数据模型
    • 配置
      • 全局配置
      • 项目内配置
      • 可配置规则
      • 脚本工具
      • Groovy 本地扩展
    • 进阶配置
      • 注释规范说明
      • 框架支持
    • 常见问题
      • 常见问题
  • 浏览器扩展
    • Chrome
    • Microsoft Edge
  • Apifox MCP Server
    • 概述
    • 通过 MCP 使用 Apifox 项目内的 API 文档
    • 通过 MCP 使用公开发布的 API 文档
    • 通过 MCP 使用 OpenAPI/Swagger文档
  • 最佳实践
    • 概述
    • 接口之间如何传递数据
    • 登录态(Auth)如何处理
    • 接口签名如何处理
    • 如何加密/解密接口数据
    • Jenkins 定时触发任务
    • 如何计算 AI 问答成本
    • 与其他成员共用数据库连接配置
    • 通过 CLI 运行包含云端数据库连接配置的测试场景
    • 通过 Runner 运行包含云端数据库连接配置的测试场景
  • 账号&应用设置
    • 账号设置
    • 语言设置
    • 网络代理
    • 快捷键
    • 数据备份与恢复
    • 更新 Apifox
    • API 访问令牌
  • 身份验证 & Auth 鉴权指南
    • 什么是 API Key
    • 什么是 Bearer Token
    • 什么是 JWT
    • 什么是 Basic Auth
    • 什么是 Digest Auth
    • 什么是 OAuth 1.0
    • 什么是 OAuth 2.0
      • 什么是 OAuth 2.0
      • 授权码授权类型
      • 授权码授权类型,带有 PKCE
      • 隐式授权类型
      • 密码凭证授权类型
      • 客户端凭证授权类型
  • 服务与隐私协议
    • 服务协议
    • 隐私协议
    • 服务等级协议
  • 参考资料
    • API 设计优先理念
    • JSON Schema 介绍
    • JSONPath 介绍
    • XPath 介绍
    • Apifox Markdown 语法
    • CSV 格式规范
    • 正则表达式
    • 安装 Java 环境
    • Runner 运行环境
    • 常见编程语言对应的数据类型
    • Socket 粘包和分包问题
    • 词汇表
    • 目录链接汇总
    • Apifox Swagger 扩展
      • 概述
      • x-apifox-folder
      • x-apifox-status
      • x-apifox-name
      • x-apifox-maintainer
    • Apifox JSON Schema 扩展
      • 概述
      • x-apifox-mock
      • x-apifox-orders
      • x-apifox-enum
    • 动态值表达式
  • 常见问题
  1. 服务与隐私协议

服务等级协议

版本号:V1.0.0 发布日期:2024 年 06 月 01 日
本服务等级协议(Service Level Agreement,以下简称“SLA”)规定了 Apifox 网站 https://apifox.com 向付费版客户提供的产品服务可用性等级指标及赔偿方案。

第一条 定义#

1.1 服务范围:客户通过 PC 客户端、PC 浏览器使用 Apifox 的服务。通过 API 等方式链接和访问 Apifox 的可用性,不在本协议所覆盖的范围内。
1.2 服务周期:一个服务周期为一个自然月,如果客户使用 Apifox 产品不满一个月则以一个月作为一个服务周期。
1.3 服务周期总分钟数:服务周期内的总天数 x 24(小时)x 60(分钟)计算。
1.4 服务不可用:当某一分钟内,客户组织内所有 Apifox 账户均不能登录 Apifox 服务,且访问 https://app.apifox.com/ 域名下的所有链接,均返回错误代码 5XX 或超时。
1.5 服务不可用分钟数:在一个服务周期内,服务不可用的分钟数之和,即服务不可用分钟数。
1.6 月度服务费用:客户在一个自然月中就单个组织所支付的服务费用,如果客户购买了多个组织,每个组织单独计算。如果客户一次性支付了多个月份的服务费用,将按照所购买的月数分摊计算月度服务费用。

第二条 可用性#

2.1 服务可用性#

2.1.1 服务可用性计算公式#

服务可用性以单个组织为维度,按照如下方式计算:
服务可用性 = (服务周期总分钟数 - 服务不可用分钟数) / 服务周期总分钟数 × 100%。

2.1.2 服务可用性承诺#

Apifox 服务可用性不低于 99.8%,如未达到前述可用性承诺,客户可以根据本协议第 3 条约定获得赔偿。

2.2 数据存储持久性#

2.2.1 数据存储持久性计算方式#

数据存储持久性 =(每月用户存储的数据或文件总数 - 每月丢失的数据或文件数)/ 每月用户存储的数据或文件总数 × 100%

2.2.2 数据存储持久性承诺#

Apifox 一个服务周期内数据持久性达 99.99999% 及以上,如未达到前述可用性承诺,客户可以根据本协议第 3 条约定获得赔偿。

2.3 除外情形#

因下述原因导致的服务不可用的时长不计入服务不可用时间:
     2.3.1 Apifox 预先通知客户后进行系统维护所引起的,包括割接、维修、升级和故障演练;
     2.3.2 Apifox 所属任何设备以外的网络、设备故障或配置调整引起的;
     2.3.3 客户未遵循产品使用文档或使用建议引起的;
     2.3.4 客户的疏忽或由客户授权的操作所引起的;
     2.3.5 客户维护不当或保密不当致使数据、口令、密码等丢失或泄漏所引起的;
     2.3.6 客户本地环境不兼容引起的;
     2.3.7 客户的浏览器等应用程序或数据信息受到黑客攻击而引起的;
     2.3.8 不可抗力引起的;
     2.3.9 客户自行升级操作系统所引起的;
     2.3.10 客户的应用程序或安装活动所引起的。

第三条 赔偿方案#

3.1 赔偿标准#

每个组织单独计算服务可用性,按照下表中的标准计算赔偿金额,赔偿总额不超过未达到服务可用性当月客户就该组织支付的月度服务费用的 30%。
可用性赔偿金额
服务可用性低于 99.8% 但等于或高于 95.00%月度服务费用的 10%
服务可用性低于 95.00% 但等于或高于 90.00%月度服务费用的 20%
服务可用性低于 90.00%月度服务费用的 30%
数据存储持久性低于 99.99999%月度服务费用的 30%

3.2 赔偿方式#

Apifox 对于未达到服务可用性时,赔偿方式仅限于用于购买该组织 Apifox 产品的代金券, 且此代金券不可转让、不可兑现。

3.3 赔偿申请方式#

客户需通过 Apifox 官网公布的客服渠道,主动联系 Apifox 申请赔偿。Apifox 接到申请后,将在 10 个工作日内作出答复,并在两个自然月内,按照 3.1 条款中的约定,退回相应款项。

3.4 赔偿申请时限#

客户可以在每个自然月第五个工作日后对上个月没有达到服务可用性承诺的组织提出赔偿申请。赔偿申请限于在 Apifox 服务没有达到服务可用性的相关月份结束后一个月内提出。超出申请时限的赔偿申请将不被受理。

第四条 其他#

Apifox 有权不时地对本 SLA 条款作出修改,且毋须另行通知。修订后的协议一旦在网页上公布即有效代替原来的服务协议。您继续访问和使用 Apifox 即视为您接受修订后的服务协议。如您不同意 Apifox 对 SLA 所做的修改,您有权停止使用 Apifox 服务,如您继续使用 Apifox 服务,则视为您接受修改后的 SLA。

第五条 法律适用#

5.1 本合约的订立、执行和解释以及争议的解决均应适用中华人民共和国法律并受中国法院管辖。
5.2 协议双方就本合约内容或其执行发生任何争议,应首先力争友好协商解决;协商不成时,任何一方均可向睿狐科技所在地人民法院提起诉讼。
修改于 2024-12-24 08:50:58
上一页
隐私协议
下一页
API 设计优先理念
Built with