概览

授权:bearer-token

除状态检查外,所有NN Agent API操作都需要在Authorization的标题中提供bearer-token。

curl https://api.nexifyneo.com/v2/client \
  -H "Authorization: Bearer YOUR_API_TOKEN"

在哪里获取令牌#

令牌在客户上发布,并在通过官方机器人@NN_official_bot连接到API时发放。网站上没有单独的表单:机器人是进入办公室和访问API的唯一入口。

令牌与账户绑定,因此在版本v2中,客户端标识符不会在路径中传递:服务通过令牌识别客户端。

没有令牌会返回什么#

没有头部的请求被拒绝,代码为 401:

{
  "error": { "code": "unauthorized", "message": "Missing bearer token" },
  "request_id": "f04e847d-8505-4b7b-a5c8-7aee42a8fc55"
}

过期或无效的令牌以相同的代码 401 被拒绝,但消息不同:

{
  "error": { "code": "unauthorized", "message": "Invalid or expired token" },
  "request_id": "3c254bf0-21bf-44ff-9469-56b8a34d4239"
}

字段 request_id 和其他代码的解析在 错误 页面上。

通过单个请求检查访问#

curl https://api.nexifyneo.com/v2/client \
  -H "Authorization: Bearer YOUR_API_TOKEN"

响应 200 表示令牌已被接受并与您的帐户关联。响应 401 — 令牌未传递或无效。

证书警告#

主机 api.nexifyneo.com 返回自签名的 TLS 证书,因此严格检查的客户端在令牌到达之前会中断连接。如果请求在证书验证失败,而不是在 401 失败,则问题不在于授权 — 请参见 已知限制

继续#

  • 账户 — 在验证令牌后第一个内容请求。
  • 错误 — 响应代码的含义。

Updated

授权:bearer-token — NN Agent