跳到主要内容

API

概述

NextConsole API 采用基于 Bearer Token 的身份认证机制,每个用户都拥有唯一的 API 密钥,用于安全地访问平台的所有 API 服务。

提示

API 明细请参考 API 文档

密钥特性

特性说明
有效期默认 7 天(604800 秒)
权限完全访问用户权限范围内的所有资源
刷新支持手动刷新延长有效期

获取 API 密钥

方法一:控制台页面获取

  1. 登录 NextConsole 控制台
  2. 点击右上角用户头像,选择"用户信息"
  3. 进入"授权信息"选项卡
  4. 复制显示的 API 密钥

获取API密钥

方法二:API 接口获取

通过登录接口获取 API 密钥

密钥管理

刷新 API 密钥

密钥默认7天后过期,可通过以下方式刷新:

控制台刷新:

  • 在授权信息页面点击"刷新"按钮
  • 系统将生成新的 API 密钥,旧密钥立即失效

**API 接口刷新 **

使用指南

请求头设置

在所有 API 请求的 Authorization 头部中包含 API 密钥:

Authorization: Bearer eyJhbGciOiJIUzI1N**************

完整请求示例

获取用户信息:

curl -X GET "https://www.nextconsole.com/next_console/login_by_password" \
-H "Authorization: Bearer nc_sk_1234567890abcdef1234567890abcdef" \
-H "Content-Type: application/json"

重要说明

  1. 安全性:API 密钥是敏感凭证,请妥善保管
  2. 存储建议:使用环境变量或密钥管理系统存储
  3. 传输安全:始终使用 HTTPS 协议进行传输
  4. 权限控制:每个 API 密钥具有完整的用户权限
  5. 及时刷新:建议定期刷新密钥以确保服务连续性

通过遵循本指南,您可以安全有效地使用 NextConsole API 密钥进行身份认证和 API 调用。