SHASHAT COEX API
    • API Instructions
    • Error Codes
    • General API
      • Retrieve Screen Information
        GET
      • Set Blackout/Freeze Screen
        PUT
      • Retrieve Preset Information
        GET
      • Retrieve All Cabinet Information
        GET
      • Apply Preset
        POST
      • Set Screen Brightness
        PUT
      • Set Screen Gamma
        PUT
      • Enable Cabinet Mapping
        PUT
      • Adjust Cabinet Color Temperature
        PUT
      • Switch Source for Layer
        PUT
      • Set EDID
        PUT
      • Retrieve Real-Time Monitoring Information
        GET
    • Input
      • Internal sources
        • Set Internal Source Information
        • Set Sending Card Test Pattern
      • Retrieve Input Information
        • Retrieve Input Source Info
        • Retrieve Input Data
      • Color Adjustment
        • Set Contrast
        • Set Black Level
        • Reset Color Adjustment
        • Set Saturation
        • Adjust Hue
      • Set HDR Mode
        • Set HDR Mode
    • Screen
      • Image
        • Color Gamut
          • Set Custom Gamut on a Screen-Basis
          • Switch Color Gamut
        • Set Brightness Limit Value
        • Set Screen Color Temperature
        • Retrieve Screen Display Effect Parameters
        • Set Custom Gamma for the Screen
      • Schedule
        • Retrieve All Schedule Information of the Screens
        • Set Schedule On\Off
        • Delete Brightness Strategy
      • Color Correction
        • Set Color Correction On/Off
        • Set Color Correction Data (Black/White)
        • Set Color Correction Data (Other Colors)
      • Process
        • 3D LUT
          • Import 3D LUT File
          • Delete 3D LUT File
          • Set 3D LUT Strength
          • Enable 3D LUT
      • Canvas
        • Canvas Mapping
      • Preset
        • Modify Preset
      • Output
        • 3D
          • 3D Emitter
            • Enable 3D Emitter
          • Enable/Disable 3D
        • Retrieve Output Parameters
          • Retrieve Screen Output Data
        • Display Mode
          • Set Blackout/Freeze Screen
        • Multi-Mode
          • Set Multi-mode by Screens
        • Retrieve Display Status
        • Set Output Bit Depth
        • Output Sync Source Switching
      • Retrieve the Number of Cabinets of the Screen
        GET
      • Retrieve Screen Properties Information
        GET
    • Device
      • Audio
        • Set Output Audio
        • Retrieve Audio Settings
      • Controller Identify
        • Controller Identify
      • Device Backup
        • Retrieve Device Backup Status
        • Primary/Backup Verify
      • Logs
        • Export Log
      • Controller Time
        • Set System Time
        • Automatic Time Setting On/Off
        • Change the time zone
      • Controller Name
        • Change Controller Name
      • SNMP
        • Retrieve SNMP On/Off Status
        • Set SNMP On/Off
      • Multifunction Card
        • Retrieve Multifunction Card Information
      • Device Identify
        • Device Identify
      • Retrieve Device Information
    • Cabinet
      • Pre-stored Image
        • Set No Data Signal
      • Thermal Calibration
        • Set Thermal Compensation On/Off
        • Thermal Compensation Intensity Adjustment
        • Set Thermal Compensation Mode
      • Brightness Adjustment
        • Set Cabinet RGB Brightness
        • Set Cabinet Brightness
      • Cabinet Display Control
        • Set Receiving Card Test Pattern
      • Multi-Mode
        • Set Multi-mode by Cabinets
      • Configure Cabinet Topology
        • Move Cabinet
      • Set Cabinet RGBW Brightness Components

    API Instructions

    Prerequisites#

    Before calling the APIs, it is necessary to ensure the following environment:
    1.
    Ensure proper communication between the PC and the device.
    2.
    Make sure that the device is not being occupied by VMP (we recommend clicking on a blank space in the device tree to release the device).

    Basic Steps for Use#

    1.
    Open a API tool of your choice.
    2.
    Find the information for the API you need to use.
    3.
    Call the API according to the documentation.

    Explanation of Request Methods#

    API request methods can be categorized as follows:
    1.
    GET method
    2.
    POST method
    3.
    PUT method
    4.
    DELETE method
    Examples:
    ####** GET Request**
    For example, to retrieve screen information:
    5.
    Open the API tool.
    image.png
    2. Find the relevant API endpoint, construct the URL using the IP address and port, change the request method to GET, then call the API to retrieve the results.
    image.png

    PUT Request#

    For example, to set the screen brightness, black screen, or freeze screen:
    Screen brightness:
    1.
    Open the API tool, set the request method to PUT and construct the URL using the IP address and port.
    Image.png
    2.
    Construct the JSON based on the documentation
    image.png
    3. Send the API request and check if it was successful.
    image.png
    Black screen and freeze screen:
    1.
    Open the API tool, set the request method to PUT and construct the URL using the IP address and port.
    image.png
    2. Construct the JSON based on the documentation
    image.png
    3. Send the API request and check if it was successful.
    image.png

    POST Request#

    For example, to apply a preset:
    1.
    Open the API tool, set the request method to POST and construct the URL using the IP address and port.
    image.png
    2.
    Construct the JSON based on the documentation
    image.png
    3.
    Send the API request and check if it was successful.
    image.png
    Modified at 2026-07-19 20:25:05
    Next
    Error Codes
    Built with