Skip to main content

Before You Start

XXTouch OpenAPI is an open interface exposed by the XXTouch service running on the device. It listens for and executes incoming commands, allowing developers to remotely control XXTouch. OpenAPI is a convenient way to integrate central control, perform remote debugging, and upload files to the device.

Before you start, please prepare the following:

  • Enable Remote Service
    If you are developing from the desktop side, you need to enable the remote service on the device first.
    Steps: Open App -> More -> Remote Service -> Enable
    See the illustrated guide: User Manual
  • Protocol: HTTP/1.1
  • Default port: 46952
  • Unless otherwise specified:
    Request text parameters should use UTF-8 encoding.
    Text returned by the API is also UTF-8 encoded.
    The HTTP status code on success is 200.
    If the remote service is not enabled, all endpoints return HTTP status code 400.