最后更新:
Click to expand / collapse
可靠的API集成不仅以速度为基础,而且基于故障行为的可预测性。我们提供完整的错误代码文档和SLA(服务级别协议)保修,以确保每个合作伙伴在任何情况下都知道对系统的期望。
这有助于规划体系结构、编写可持续代码以及信任集成,即使在关键情况下也是如此。
SLA和错误文档中包含的内容
| 章节 | 包括什么 |
|---|---|
| SLA指标 | Uptime,平均响应时间,允许的错误数 |
| 临时条例 | 最大反应时间和事件消除 |
| 错误代码(HTTP status) | 解密4xx/5xx代码,处理建议 |
| 响应主体中的错误 | JSON错误格式,字段"code","message","details" |
| 错误处理示例 | 处理401、403、429、500等错误的例子 |
| Taymauts的行为 | 当超出限制或API不可用时该怎么办 |
为什么企业和开发人员需要它
对API稳定性的信心
快速识别故障原因
减少支持负载
自动处理客户端代码中的错误
在负荷和事件时对系统有明确的期望
我们如何实现
发布错误代码文档(Swagger, Redoc, Markdown)
开发人员门户网站上关于SLA的单独部分
通过Prometheus、Datadog、UptimeRobot设置SLA指标
与Alert和监控集成
通过SLA触发器和滴答系统提供事件支持
在哪里,特别重要
金融和保险服务
关键移动应用程序
拥有更多客户的B2B平台
具有SLA承诺的公共API