API Overview
API Overview
SIYB E API 的总体设计：资源、认证、分页、错误模型与速率限制。首版先发布契约，真实服务端后续在 api.siybe.com 开放。
01
概览
SIYB E API 的总体设计：资源、认证、分页、错误模型与速率限制。首版先发布契约，真实服务端后续在 api.siybe.com 开放。
02
要点
API 的目标不是"把所有页面都暴露成接口"，而是让结构化对象可被程序化获取：指标、单位、算法、阈值、标准。
03
要点 2
设计原则：只读为主、标识稳定、版本在路径中（/v1/）、所有响应带 ETag 与 Cache-Control。
04
要点 3
认证：公开读接口使用 API Key（标注调用方身份与配额）；写接口暂不开放。
05
结构定义
| 端点 | 方法 | 说明 |
|---|---|---|
| /v1/metrics | GET | 指标字典列表（支持 domain / 分页） |
| /v1/metrics/{id} | GET | 单个指标定义 |
| /v1/measurements/{id} | GET | 测量量详情含关系边 |
| /v1/technologies | GET | 技术列表（支持 domain / level） |
| /v1/algorithms/{id} | GET | 算法定义与参数 |
| /v1/thresholds | GET | 阈值列表（支持 metric / status） |
| /v1/units | GET | 单位注册表 |
| /v1/search | GET | 全站检索（q / type / domain） |
CLOSE
把 API Overview 用起来
相关技术
下一步
实际项目如何应用？
场景设计、设备选型与工程实施，见 xmsiyb.cn 行业应用与智能选型中心。
场景设计、设备选型与工程实施，见 xmsiyb.cn 行业应用与智能选型中心。
相关 SIYB 产品
正式参数、方案与商务资料以 xmsiyb.com 官网为准。
需要把技术判断落到项目？
进入行业应用与智能选型中心，获取场景设计、选型与实施参考。