Skip to main content

Introduction

Overview​

The Data Platform provides developers with comprehensive device data integration and management capabilities through OpenAPI. Developers can deeply integrate external systems with the data platform, achieving automated device data collection, query, and analysis while ensuring data transmission security.

OpenAPI operations are primarily divided into two core parts: Token Security Management and API Core Functions.

Token Security Management​

tip

RSA Token: An API authentication credential based on asymmetric encryption algorithm, using public key encryption and private key decryption mechanism to ensure data transmission security.

JWT Token: A JSON-based open standard token that uses digital signatures to ensure token integrity and trustworthiness.

  1. Supports two token authentication mechanisms: RSA and JWT.

  2. RSA tokens use asymmetric encryption to ensure transmission security; JWT tokens are suitable for user-level authorization.

  3. Provides complete token lifecycle management: application, authorization configuration, download/copy, deletion.

  4. Each token can finely control API access permissions and project data scope.

API Core Functions​

tip

Data Service API: Standardized interfaces for external systems (such as operational dashboards, mobile apps) to call data from the data middle platform, supporting both query and subscription modes.

  1. Device Data Operations: Supports device time-series data push (maximum 1000 entries per request), device detail query, device list paginated query, device point latest value and historical value query.

  2. Data Warehouse Integration: Provides dataset data push and query interfaces.

  3. Unified Authentication Mechanism: All interfaces are authenticated via encrypted tokens in the request header.

  4. Common Error Handling: Includes a common error code system, such as 401 (token expired), 428 (user does not exist), etc.