免费注册
返回博客
教程

API Key 生命周期管理

从安全创建、IP 限制、使用与监控,到撤销、替换和 Webhook Secret 轮换,完整管理 MangoOTP API Key。

每个 API Key 都应有明确所有者、用途和复核时间,即使凭据本身尚未过期,也应定期确认是否仍然需要。生命周期管理可以缩短意外泄露影响的时间和系统范围。

创建前先规划

确定接入应用、责任人、允许的出口地址、所需接口、秘密保存位置、监控联系人和替换步骤。

处理“API Key 生命周期管理”时,应把“创建前先规划”作为一个独立检查点,不要同时修改多个条件。记录页面现象、操作时间和相关业务编号,每次只执行一个有依据的步骤,并等待系统给出明确结果。

原始值只获取一次

MangoOTP 只在创建响应中返回带 mago_live_ 前缀的原始 Key。应直接保存到受保护的秘密系统,不能复制到工单或聊天。

处理“API Key 生命周期管理”时,应把“原始值只获取一次”作为一个独立检查点,不要同时修改多个条件。记录页面现象、操作时间和相关业务编号,每次只执行一个有依据的步骤,并等待系统给出明确结果。

维护最小 IP 白名单

非空白名单是强制要求。使用尽可能窄的 IPv4 或 CIDR 范围,并在部署出口地址变化前完成更新。

处理“API Key 生命周期管理”时,应把“维护最小 IP 白名单”作为一个独立检查点,不要同时修改多个条件。记录页面现象、操作时间和相关业务编号,每次只执行一个有依据的步骤,并等待系统给出明确结果。

只运行一个有效 Key

每个用户最多有一个有效 API Key。不能创建重叠有效凭据,也不应让互不相关的系统和责任人共享同一 Key。

处理“API Key 生命周期管理”时,应把“只运行一个有效 Key”作为一个独立检查点,不要同时修改多个条件。记录页面现象、操作时间和相关业务编号,每次只执行一个有依据的步骤,并等待系统给出明确结果。

使用安全标识监控

运营排查使用展示前缀、请求结果、错误 code 和 traceId。绝不能记录原始 Key、数据库哈希或授权请求头。

处理“API Key 生命周期管理”时,应把“使用安全标识监控”作为一个独立检查点,不要同时修改多个条件。记录页面现象、操作时间和相关业务编号,每次只执行一个有依据的步骤,并等待系统给出明确结果。

泄露或停用时立即撤销

撤销会使有效 Key 立即失效,并从有效列表移除。还应确认所有依赖系统停止继续发送旧凭据。

处理“API Key 生命周期管理”时,应把“泄露或停用时立即撤销”作为一个独立检查点,不要同时修改多个条件。记录页面现象、操作时间和相关业务编号,每次只执行一个有依据的步骤,并等待系统给出明确结果。

有计划地创建替代 Key

只有旧 Key 撤销后才能创建替代凭据。更新受保护配置,并执行一次范围受控的验证请求。

处理“API Key 生命周期管理”时,应把“有计划地创建替代 Key”作为一个独立检查点,不要同时修改多个条件。记录页面现象、操作时间和相关业务编号,每次只执行一个有依据的步骤,并等待系统给出明确结果。

单独管理 Webhook Secret

Webhook 配置归属于当前有效 Key。签名秘密只在创建或轮换时展示,应独立保存、验证和替换。

处理“API Key 生命周期管理”时,应把“单独管理 Webhook Secret”作为一个独立检查点,不要同时修改多个条件。记录页面现象、操作时间和相关业务编号,每次只执行一个有依据的步骤,并等待系统给出明确结果。

实际操作检查清单

  1. 核对“创建前先规划”对应的信息,保存可验证结果;只有下一步含义明确时才继续操作。
  2. 核对“原始值只获取一次”对应的信息,保存可验证结果;只有下一步含义明确时才继续操作。
  3. 核对“维护最小 IP 白名单”对应的信息,保存可验证结果;只有下一步含义明确时才继续操作。
  4. 核对“只运行一个有效 Key”对应的信息,保存可验证结果;只有下一步含义明确时才继续操作。
  5. 核对“使用安全标识监控”对应的信息,保存可验证结果;只有下一步含义明确时才继续操作。
  6. 核对“泄露或停用时立即撤销”对应的信息,保存可验证结果;只有下一步含义明确时才继续操作。
  7. 核对“有计划地创建替代 Key”对应的信息,保存可验证结果;只有下一步含义明确时才继续操作。
  8. 核对“单独管理 Webhook Secret”对应的信息,保存可验证结果;只有下一步含义明确时才继续操作。

最终业务状态和账户流水是判断结果的依据。截图或客服沟通中不要发送密码、完整验证码、认证密钥、Access Token、API Key 或未遮挡的身份材料。更多说明可查看 MangoOTP 帮助中心