跳到主要内容

API 简介

时间服务器系列高精度时间同步产品的REST API旨在管理这些时间同步产品，这些产品基于PTP（精确时间协议）和NTP（网络时间协议）服务，用于为网络设备提供精确的授时功能。 通过使用这个REST API，用户可以轻松地集成时间同步产品到他们的网络设备中，确保网络设备始终保持精确的时间同步，提高网络性能和可靠性。同时，用户还可以方便地管理和监控时间同步产品的运行状态，及时发现并处理任何问题。

该REST API可以实现以下功能：

  • 获取时间同步产品的当前时间和状态信息。
  • 设置时间同步产品的时间源和同步参数。
  • 监控时间同步产品的健康状态和性能指标。

时间服务器系列高精度时间同步产品的REST API为网络设备的时间同步提供了一种简单、灵活和高效的管理和控制方式，为用户提供了更好的时间同步体验。

整体使用指南​

本API采用RESTful风格，使用JSON格式的数据进行请求和响应。在使用时间服务器系列高精度时间同步产品的REST API时，您需要遵循以下步骤：

  1. 获取API访问授权的token：在使用时间服务器系列高精度时间同步产品的REST API之前，您需要先获取访问授权的token。没有token信息，或是token和设备不匹配，您将无法访问API。
  2. 使用POST请求访问API：在使用时间服务器系列高精度时间同步产品的REST API时，您需要使用POST请求来访问API。请求时候数据参数使用JSON格式，请求参数使用HTTP请求Body传递，Content-Type为application/json。并且包含Content-Length头，代表请求数据的长度。
  3. 请求认证：在请求头中添加Authorization字段，用于传递token信息。Authorization字段的值为token信息，是一个JWT Token，由酷鲨科技颁发给用户。每个设备有唯一的Token。
  4. 得到响应信息：如果请求成功，您将会得到响应信息。响应信息为JSON格式的数据，您可以通过解析JSON数据来获取API调用的结果信息。
  5. API调用的返回HTTP状态码：
  • API调用返回的HTTP状态码为统一200，其他状态码均为通信错误状态码。
  • 通信错误状态码包括：400、401、403、404、500等，具体错误码的含义请参考HTTP协议的相关文档。

响应信息包括以下字段：

{
  "success": true|false,
  "data"?: {},
  "errorCode"?: "option string",
  "errorMessage"?: "option string",
  "showType"?: 0|1|2|4|9,
  "traceId"?: "option string"
}
  • success字段表示API调用是否成功，true表示成功，false表示失败，失败时候会有errorCode和errorMessage字段。
  • data字段表示API调用成功返回的业务数据
  • errorCode字段表示API调用返回的错误码，用于前端展示错误信息
  • errorMessage字段表示API调用返回的错误信息， 用于前端展示错误信息，使用点分隔的英文信息，在前端进行国际化
  • showType字段表示API调用返回的错误展示类型，用于前端展示错误信息，0: 不展示 1: 通知 2: 警告 4: 错误 9: 在页面内部展示的错误，如表单验证错误
  • traceId字段表示API调用返回的错误追踪ID，用于追踪错误信息的id，一般用于服务端错误的追踪, 可以忽略

正确响应结果json 示例：

{
  "success": true,
  "data": {
    "username": "andyWang",
    "token": "jwt"
  }
}

错误响应结果json 示例：

{
  "success": false,
  "errorCode": "40001",
  "errorMessage": "username.password.error",
  "showType": 9,
  "traceId": "01"
}

通过遵循以上使用指南，您可以顺利地获取访问授权的token，并且开始使用时间服务器系列高精度时间同步产品的REST API进行时间同步管理操作。如果在使用过程中遇到任何问题，请及时联系管理员或API提供商进行进一步的支持和解决。