Token 认证

使用认证Token访问API

描述

Token认证是一种通过在请求头中传递Token来进行身份验证的方式。Token是一串字符串，由酷鲨科技颁发给用户，用于访问API。 Token包含被认证的设备ID，与设备绑定，请不要在不同设备上尝试使用同一个Token。 Token也包含角色信息，每个角色绑定具体权限。只有具备相应权限的Token才能访问API。

使用Token访问API

在请求酷鲨设备的API时，您需要在请求头的Authorization中添加Token信息，Token信息是一个字符串，用于鉴权。如下是一个HTTP请求头的示例：

POST /api/v1/system/get_info HTTP/1.1
Host: 192.168.188.188:8080
Content-Type: application/json
Content-Length: 2
Accept: application/json
Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkZXZpY2VJRCI6IjEw

{}

提示

酷鲨设备API只支持POST请求，不支持GET请求。每个业务请求都包含JSON请求参数，即使是空对象。
Authorization中的Token信息是一个字符串，用于鉴权。是一个JWT Token，由酷鲨科技颁发给用户。每个设备有唯一的Token。

角色

TODO 角色信息

Token包含角色信息，角色信息包含用户的权限信息。如果当前角色不具备API的访问权限，将会被拒绝访问。请根据您的角色信息，选择合适的API访问权限。

Root 具备以下权限：

{
  "menu": [
    "dashboard",          // 仪表盘
    "dashboard_status",   // 仪表盘状态
    "dashboard_alarm",    // 仪表盘告警
    "clock",              // 时钟设置
    "clock_config",       // 参数配置
    "clock_ptp_port",     // PTP端口配置
    "clock_pps_tod",      // PPS/TOD配置
    "network",            // 网络设置
    "network_ptp_port",   // PTP端口配置
    "network_mgmt_port",  // 管理端口配置
    "system",             // 系统设置
    "system_managements", // 系统管理
    "system_profile",     // 系统配置
    "license"             // 许可证管理
  ],
  "ptp": [
    "get_global_params",  // 获取PTP全局参数
    "save_global_params", // 保存PTP全局参数
    "profile_list",       // PTP预设配置列表
    "params_list",        // PTP端口参数列表
    "save_params",        // 保存PTP端口参数
    "status_list",        // PTP端口状态列表
  ],
  "clock": [
    "get_status",         // 获取时钟状态
    "save_time_zone",     // 保存时区
    "get_utc_time",       // 获取UTC时间
    "get_time_sources",   // 获取时间源
    "save_time_sources",  // 保存时间源
  ],
  "pps_tod": [
    "get_output_params",  // 获取PPS/TOD输出参数
    "save_output_params", // 保存PPS/TOD输出参数
    "get_input_params",   // 获取PPS/TOD输入参数
    "save_input_params",  // 保存PPS/TOD输入参数
  ],
  "network": [
    "ptp_port_list",      // PTP端口网络参数列表
    "save_ptp_port",      // 保存PTP端口网络参数
    "mgmt_port_list",     // 管理端口网络参数列表
    "save_mgmt_port",     // 保存管理端口网络参数
  ],
  "license": [
    "get_license",        // 获取许可证信息
    "replace_license",    // 替换许可证
    "restore_license",    // 恢复许可证
  ], 
  "system": [
    "get_info",           // 获取系统信息
    "power_status",       // 获取电源状态
    "download_config",    // 下载配置
    "upload_config",      // 上传配置
    "restore_default",    // 恢复默认配置
    "reboot",             // 重启
    "hot_start",          // 热启动
    "shutdown",           // 关机
    "upgrade_firmware",   // 升级固件
    "upgrade_status",     // 查询升级状态
  ],
  "alarm": [
    "alarm_list",         // 告警列表
    "clear_alarm",        // 清除告警
    "get_params",         // 获取告警参数
    "save_params",        // 保存告警参数
    "delete_alarm",       // 删除告警
  ]
}

Token 认证

使用认证Token访问API​

描述​

使用Token访问API​

角色​

使用认证Token访问API

描述

使用Token访问API

角色