关于 Element 软件 API

Element API 基于 HTTPS 上的 JSON-RPC 协议。JSON-RPC 是一种基于轻型 JSON 数据交换格式的简单文本 RPC 协议。客户端库可用于所有主要的编程语言。

可以通过 HTTPS POST 请求向 API 端点发出 API 请求。POST 请求的正文是一个 JSON-RPC 请求对象。API 当前不支持批处理请求(即在一个 POST 中包含多个请求对象)。提交 API 请求时,可以使用“application/json-rpc”作为请求的内容类型,并确保正文未采用表单编码格式。

注: Element Web UI 将使用本文档中所述的 API 方法。可以通过启用 API 日志来监控 UI 中的 API 操作;这样您可以查看对系统发出的方法。您可以同时启用请求和响应,查看系统对所发出的方法的回复。

除非另有规定,否则 API 响应中的所有日期字符串均为 UTC+0 格式。

注: 如果存储集群负载过重,或者您提交了大量连续 API 请求而中间没有任何延迟,则某个方法可能会失败并返回错误“xDBVersionMismatch”。如果发生这种情况,请重试此方法调用。