API 设计理念
了解 TurningAPI 的设计哲学、架构原则和核心能力，帮助您更好地理解和使用我们的 API 服务。
简介
欢迎使用估图 TurningAPI。我们的 API 采用 RESTful 架构设计，围绕"人、企、地、资、链、产、事"七大数据维度， 为金融、政府、企业提供全方位的风险评估与决策支持能力。
七大数据维度
TurningAPI 围绕七个核心数据维度构建，覆盖从个人到企业、从区域到产业链的全方位数据洞察。
人 (Person API)
20+ 端点
全方位洞察个人用户的身份、信用与行为特征，提供个人风险评估和信用分析能力。
企 (Enterprise API)
120+ 端点
深度解析企业的工商、经营、司法与供应链风险，为企业决策提供数据支持。
地 (Geography API)
10+ 端点
区域经济、产业与金融数据的综合分析，支持区域经济发展和政策制定。
资 (Asset API)
3+ 端点
个人与企业资产的评估与核查服务，提供资产分析和风险评估能力。
链 (Chain API)
24+ 端点
产业链与供应链的全景分析与风险评估，识别供应链断裂风险。
产 (Product API)
18+ 端点
产品价值、市场表现与技术健康度分析，支持产品决策和投资分析。
事 (Event API)
70+ 端点
事件追踪与动态监控服务，实时跟踪重要事件和动态变化。
RESTful 架构设计
TurningAPI 严格遵循 RESTful 架构原则，确保 API 的一致性、可预测性和易用性。
统一的资源标识
所有资源都通过清晰的 URL 路径进行访问，遵循 RESTful 命名规范。
标准 HTTP 方法
使用 GET、POST、PUT、DELETE 等标准 HTTP 方法表达操作语义。
JSON 数据格式
所有请求和响应都使用 JSON 格式，确保跨平台兼容性。
状态码语义化
使用标准 HTTP 状态码和自定义错误码，清晰表达请求结果。
设计原则
简洁性
API 设计力求简洁明了，减少学习成本。每个端点都有清晰的用途和直观的命名。
一致性
所有 API 端点遵循统一的命名规范、参数格式和响应结构，确保开发者体验的一致性。
可扩展性
架构设计支持水平扩展，能够应对高并发场景，同时保持 API 的向后兼容性。
安全性
所有 API 请求都需要认证，支持细粒度的权限控制，确保数据安全和隐私保护。
可靠性
提供高可用性服务，99.99% 的可用性保证，完善的错误处理和监控机制。
认证机制
所有 API 请求都必须在 HTTP Header 中包含您的 API Key 进行认证。
Authorization: Bearer YOUR_API_KEY安全提示：请勿在客户端代码中暴露您的 API Key，建议使用环境变量或安全的密钥管理服务。
错误处理机制
估图 TurningAPI 使用标准的 HTTP 响应代码来指示 API 请求的成功或失败，同时提供详细的错误信息帮助开发者快速定位问题。
| HTTP 状态码 | 错误码 | 描述 |
|---|---|---|
| 400 | 40001 | 请求参数格式错误或缺失 |
| 401 | 40101 | API Key 无效或未提供 |
| 403 | 40301 | 无权访问该 API |
| 404 | 40401 | 未找到匹配的记录 |
| 429 | 42901 | 请求频率超限 |
| 500 | 50001 | 服务内部错误 |
速率限制策略
为确保服务的稳定性和公平性，我们对 API 调用频率进行了限制。不同套餐提供不同的速率限制。
标准套餐
100 请求/分钟
专业套餐
1000 请求/分钟
企业套餐
无限制（专属集群）
最佳实践
使用 SDK
优先使用官方提供的 SDK，它们已经处理了认证、错误处理和重试逻辑，可以大幅简化开发工作。
保护 API Key
永远不要在客户端代码或公共仓库中暴露 API Key。使用环境变量或安全的密钥管理服务。
实现重试机制
对于临时性错误（如 429、500），实现指数退避的重试机制，提高请求成功率。
监控和日志
记录 API 调用日志，监控错误率和响应时间，及时发现和解决问题。