接口概览
引言
本文档介绍了数据配置的各类API,您可以分别查看各API的具体信息,用途。
接口类型
- 对外接口:包括 高性能读接口,以及网址中带
/api/public/
的所有接口。这些接口只能拉取表数据,通常有缓存。 - 管理接口:除了对外接口外,都是管理接口。这些接口 不能暴露给外网使用,会涉及数据安全问题,典型的包括 开放读写接口 等等。
数据接口
切勿在前端使用 管理接口 ,否则容易导致 masterkey / authid&authkey 泄露,造成安全风险!
如果只是读取数据,而且不介意缓存,请使用 高性能读接口 ,性能更好!而且安全!
HTTP接口
API | 类型 | 描述 | 可用鉴权方式 |
---|---|---|---|
高性能读接口 | 对外 | 只用于拉取表数据,高性能带缓存。 | schemakey ,appkey |
读写接口 | 管理 | 可对表结构,表数据进行读写操作,无缓存。 | authid&authkey,masterkey |
版本管理接口
API | 类型 | 描述 | 鉴权方式 |
---|---|---|---|
表版本接口 | 管理 | 包括表版本管理,灰度管理 | authid&authkey |
行版本接口 | 管理 | 包括行版本管理,灰度管理,行版本策略 | authid&authkey |