介绍 - Flashcat API

简介

对外的接口整体上分 2 类：

用于页面功能，给 JavaScript 调用的，以 /api/n9e 打头

用于第三方系统调用的，以 /v1/n9e 打头

`/api/n9e` 类接口

新方式

夜莺在 v8.0.0-beta.5 支持了使用 token 对此类接口进行鉴权，可以在个人信息管理-token 管理，创建 token，然后在调用接口的时候，将 token 写到 Header 中，Header 的 key 为 X-User-Token

使用此方式之前，需要在配置文件中打开 TokenAuth 配置,在 config.toml 中加如下配置

[HTTP.TokenAuth]
Enable = true

旧方式（不推荐使用）

这类接口的认证走的是 jwt，需要获取 access_token，然后把 access_token 放到 Header 里。首先调用 /api/n9e/auth/login 接口来登录：

登录成功，后端返回了两个 token，access_token 和 refresh_token，程序要记录下来，后面有用，然后就可以调用普通接口了，调用的时候把 access_token 以 Bearer 的方式放到 Authorization 里：

access_token 有效期是 15 分钟，过期之后，可以调用 /api/n9e/auth/refresh 接口用 refresh_token 换一个新的 access_token，当然，也会顺道返回一个新的 refresh_token，举例：

OK，如上就是认证方法。那 /api/n9e 打头的接口具体有哪些呢？打开 Chrome 开发者工具，看看页面上发起的请求就一目了然了，或者查阅夜莺的 router 文件亦可知道全量接口。

`/v1/n9e` 类接口

这类接口其实又分成 2 小类：

给 agent 使用，用于 agent 上报心跳信息或者接收监控数据，通常用于内网不加密钥认证

给第三方调用的接口，通常会走密钥认证

这 2 类接口都是走的 BasicAuth 认证，通过配置文件里下面的部分来控制：

[HTTP.APIForAgent]
Enable = true 
# [HTTP.APIForAgent.BasicAuth]
# user001 = "ccc26da7b9aba533cbb263a36c07dcc5"

[HTTP.APIForService]
Enable = true 
[HTTP.APIForService.BasicAuth]
user001 = "ccc26da7b9aba533cbb263a36c07dcc5"

具体有哪些接口可以用呢：

中心端 n9e 接收心跳的接口是 /v1/n9e/heartbeat n9e-edge 接收心跳的接口是 /v1/n9e/edge/heartbeat

接收数据的接口在这里

第三方调用的接口在这里

介绍

简介#

/api/n9e 类接口#

新方式#

旧方式（不推荐使用）#

/v1/n9e 类接口#

简介

`/api/n9e` 类接口

新方式

旧方式（不推荐使用）

`/v1/n9e` 类接口