HTTP API

TeaWeb提供了一组HTTP API，方便用户从TeaWeb获取一些有用的数据，或者对TeaWeb进行操作。

注意：以下内容仅从v0.1.6开始支持。

API URL

只需要在某个具体的API路径前面加入TeaWeb访问地址即可：

  1. http://TeaWeb访问地址/API路径

比如：

  1. http://192.168.1.100:7777/api/v1/status?TeaKey=W7cy2eFpOKOPgOlaoDgbX11QNPAgIL5E

其中TeaKey是每个API URL都必须带的参数，用于认证。

认证

通常我们使用在API的URL中指定TeaKey参数来认证API：

  1. http://TeaWeb访问地址/API路径?TeaKey=登录用户密钥

其中，在”设置”>“登录设置”中可以查看你的登录用户密钥：api_monitor1.png如果还没有生成密钥，按照界面的提示点击生成即可。

比如你的TeaWeb访问地址是192.168.1.100:7777，一个API路径是/api/v1/status，密钥是123456，那么调用TeaWeb API的完整地址是：

  1. http://192.168.1.100:7777/api/v1/status?TeaKey=W7cy2eFpOKOPgOlaoDgbX11QNPAgIL5E

操作失败

如果操作失败，则返回HTTP状态码400：

  1. 400 Bad Request
  2. Content-Type: application/json; charset=utf-8
  3. ...
  5. {
  6.     code: 400,
  7.     data: { },
  8.     errors: null,
  9.     message: "Authenticate Failed 002"
  10. }

易读的JSON格式

如果要想返回更加易读的JSON格式，可以在参数中添加 TeaPretty 参数，比如：

  1. http://192.168.1.100:7777/api/v1/status?TeaKey=W7cy2eFpOKOPgOlaoDgbX11QNPAgIL5E&TeaPretty

API列表

以下API列表中的${xxx}用来表示一个变量，实际调用的时候需要将变量值代入。

系统提供的API列表如下：