NovaCloud-EN
    NovaCloud-EN
    • API Access Guide
    • Common HTTP Status Codes
    • VNNOX
      • Player
        • Player Management
          • Obtain player list
        • Obtaining Player Status
          • Obtaining Basic Player Information
          • Obtaining Player Configuration Status
      • Solutions
        • Emergency Insertion
          • Single-Page Emergency Insertion Solutions
          • Canceling Emergency Insertion Solutions
        • Program widget examples
          • Hand-drawn clock widget
          • Weather widget
          • Environmental Monitoring widget
        • Common Solutions
        • Offline Export
        • Over-specification Detection Switching
        • Program Over-specification Detection
      • Real-Time Control
        • NTP Time Synchronization
        • Synchronous playback
        • Brightness Adjustment
        • Screenshots
        • Volume Adjustment
        • Video Source Switching
        • Screen Status
        • Restart Players
        • Screen Power
      • Scheduled Control
        • Scheduled Screen Status
        • Scheduled Restart Players
        • Scheduled Volume Adjustment
        • Scheduled Brightness Adjustment
        • Scheduled Video Source Switching
      • Logs
        • Play Logs
          • Batch Searching for Play Log Overviews
          • Batch Searching for Play Log Details
          • Searching for the Play Log Detail of a Single Player
          • Searching for the Play Log Overview of a Single Player
        • Obtaining Control Command Execution Logs
      • Notifications
        • Video Source Change Notifications
        • Solution Change Notifications
    • VNNOXCare
      • Notes
      • Device Status Monitoring
        • Receiving Card
          • Topology Information
          • Basic Information
          • Monitoring Information
          • Alarm Information
        • Screen
          • Screen list
          • Monitoring Information
        • Master Controller
          • Basic Information
          • Alarm Information
          • Operating Parameters Information
        • Smart Module
          • Monitoring Information
          • Alarm Infomation
        • Input Source
          • Monitor Infomation
        • Module/Cabinet
          • Monitoring Information
        • Monitoring Card
          • Monitoring Information
      • Brightness Log
        • Brightness History
    • Others
      • Third-Party System Authorization
        • Obtaining User List
        • Obtaining Login URL

    API Access Guide

    Introduction#

            NovaCloud Open Platform serves as the foundation of NovaCloud open ecosystem, offering users all-round content publishing, device management and monitoring to facilitate the creation of intelligent digital content publishing solutions.
            This platform integrates comprehensive resources such as API documentation and online debugging tools. With this platform, users only need to write a minimal amount of code to quickly get started with and call NovaCloud services, enabling content publishing, monitoring and maintenance for LED displays. By leveraging rich API resources, users can deeply engage in system integration, enhancing the efficiency of existing IT systems and delivering greater business value.
            NovaCloud Open Platform provides the capabilities of VNNOX Media and VNNOX Care:
    VNNOX Media APIs focuses on content publishing and playback control. With the APIs, users can obtain information such as player list, player status, player operation control, content publishing control, and play logs.
    VNNOX Care APIs focus on monitoring the operating status of devices and screens. With the APIs, users can obtain the basic information and operating status data of devices and screens.
    In addition, NovaCloud Open Platform also offers an interface that allows users to redirect to VNNOX Media without requiring a password.
            For developers preparing to call NovaCloud Platform APIs, it is crucial to understand the entire process of API calls and know about the relevant technical details. This document will provide detailed introduction and guidance to help developers quickly master the API calling methods, including key technical points such as request structure and authentication. By reading this document, developers will become familiar with the complete process of calling the APIs and have the required technical capabilities to be fully prepared to carry out development work on the NovaCloud platform. We hope this document can provide you with valuable reference and help. If you have any questions, please feel free to let us know.

    Features#

    Provides interface calling methods for content publishing to enable content publishing control for LED displays.
    Provides interface calling method for monitoring and maintenance to enable operating status monitoring of various devices on the entire link of an LED display.
    Supports API name search.
    Supports online management of secret keys.
    Supports online API debugging.

    Supported Devices#

    Devices supported by content publishing interfaces: TU/TB/T series
    Devices supported by monitoring interfaces: MSD/MCTRL series, V/VX series, TU/TB/T series

    Preparation#

    Please prepare the above supported devices.
    To use content publishing APIs, bind the devices to VNNOX Media by using ViPlex Express or remotely.
    To use monitoring APIs, bind the devices to VNNOX Care by using NovaLCT or import the devices from VNNOX Media to VNNOX Care.
    Before using API Open Platform, please log in.
    1.png
    2.png

    Access Procedure#

    1
    Obtain the Application Access Key (AK/AS).
    What is an AK/AS
    AK：AppKey ID , an application access key ID to identify the user. A user can have only one AK.
    AS：AppKey Secret , a secret application access key used as a password to verify that you own the AppKey.
    An AK corresponds to a unique AS and the user generates API interface authentication information with the AK/AS.
    How to obtain an AK/AS
            First, sign up and log in to NovaCloud Open Platform. NovaCloud services are independently deployed in many countries and regions to ensure data isolation and security. In order to access the cloud services in your region, please select the correct node to log in. Users who already have a VNNOX Media or VNNOX Care account can log in directly. After logging into the platform, users will be automatically provided with AK/AS, API service domain names, and basic permissions to call APIs by default. Upon successful enterprise authentication, users can obtain the complete API interface calling permissions.
    3.png
    2
    Confirm the request address (URL)
            NovaCloud services distinguish requests based on the request paths. The service domain name can be obtained on NovaCloud Open Platform. For the specific API paths, see the API document.
    Request protocol: https
    Service domain name example: openapi-us.vnnox.com
    API request path example:/v2/player/list
    The request protocol, API service domain name, and specific API request path can be combined into a complete request address (URL).
    Example：https://openapi-us.vnnox.com/v2/player/list
    3
    Prepare public request parameters
            To ensure the security of API calls, The NovaCloud server will authenticate each API access request. Each API must be configured with public request parameters first, including AppKey, Nonce, CurTime, and CheckSum. Public request parameters should be placed in the Request Header. All public request parameters are of string type.
    ParameterDescription
    AppKeyAccess key ID.
    NonceRandom string (8 to 64 characters, numbers or English letters only)
    CurTimeCurrent UTC timestamp, the number of seconds since 00:00:00, January 1, 1970. To ensure the authenticity and timeliness of the request, the timestamp error between the client and the server should be within 5 minutes. Requests exceeding the maximum error threshold are considered invalid.
    CheckSumGenerate a request signature based on AK/AS. See step 4 for details. CheckSum = SHA256(AppSecret + Nonce + CurTime)
    4
    Generate a request signature (CheckSum)
            CheckSum can be generated by combining the obtained AppSecret with Nonce and CurTime into a string and then performing a SHA256 hash calculation.CheckSum = SHA256(AppSecret + Nonce + CurTime)
            After calculating and generating CheckSum, fill the value into the public request header in the previous step. After receiving the API request, the NovaCloud server will also use the same method to calculate and verify CheckSum.
    Java Example
    Go Example
    Python Example
    PHP Example
    5
    Assemble specific API request parameters
    After configuring the public request parameters, continue to configure the specific business parameters of the related APIs.
    GET interface: Business parameters are passed in the URL path using the Content-Type: application/x-www-form-urlencoded method.
    POST interface: Business parameters are passed in the request body using the Content-type: application/json; charset=utf-8 method.
    6
    Initiate the request
    Request example: public request header parameter preparation
    Request example: cURL simulates sending a request
    Successful request example
    Failed request example

    Rate Limits#

            To ensure the stability and availability of our API service, we have limited the rate for API calls. When a user's API call frequency exceeds the limit, the server will return "429 Too Many Requests". Please schedule your API calls appropriately to avoid triggering these rate limits and ensure the best API usage experience. If you have any questions, please feel free to contact us.
    Instantaneous call frequency limit per IP address: No more than 15 calls per second
    Cumulative call frequency limit per IP address: No more than 1500 cumulative calls per hour

    Business Process Example#

    Content Publishing Process Example
    4.png
    Screen Monitoring and Maintenance Process Example
    5.png
    Modified at 2024-09-26 05:52:32
    Next
    Common HTTP Status Codes
    Built with