Welcome back, John!

1) Authentication (API key + secret)

Authentication is done using an API key and API secret. For REST requests, include them as headers: x-api-key and x-api-secret. You can validate credentials using /api/auth/validate.

curl -X POST "http://103.102.234.102:9000/api/auth/validate" \
  -H "Content-Type: application/json" \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "x-api-secret: <YOUR_API_SECRET>" \
  -d '{"apiKey":"<YOUR_API_KEY>","apiSecret":"<YOUR_API_SECRET>"}'

Tip: See Test WebSocket for a working reference implementation.

2) Calling the API

All REST endpoints are under the API base URL. A common pattern is: http://103.102.234.102:9000/api/...

const API_BASE = "http://103.102.234.102:9000/api"

const res = await fetch(API_BASE + "/dashboard/stats", {
  headers: {
    "x-api-key": "<YOUR_API_KEY>",
    "x-api-secret": "<YOUR_API_SECRET>",
  }
})

const data = await res.json()
console.log(data)

3) Connecting to WebSocket

Connect to the WebSocket URL, then authenticate by sending a message: {"type":"authenticate","apiKey":"...","apiSecret":"..."} (same credentials as your REST headers).

const ws = new WebSocket("ws://103.102.234.102:9000")

ws.onopen = () => {
  ws.send(JSON.stringify({
    type: "authenticate",
    apiKey: "<YOUR_API_KEY>",
    apiSecret: "<YOUR_API_SECRET>",
  }))
}

ws.onmessage = (event) => {
  const msg = JSON.parse(event.data)
  console.log(msg)
}

Tip: You can also use the built-in Test WebSocket page to validate connectivity and copy the working flow.

4) System Statuses (what they mean)

The UI shows status indicators for WebSocket, API, and Database connectivity. Typical meanings:

• Connected / Online: the service is reachable and responding.
• Disconnected / Offline: the service cannot be reached (network/server down) or connection dropped.
• Operational: API is responding without errors.
• Error: API call failed or returned an error response.

# Health / status examples
curl "http://103.102.234.102:9000/api/dashboard/health"
curl "http://103.102.234.102:9000/api/dashboard/activity"

5) Sharing / Downloading

Use the Download (.md) button to download a copy of this page as a Markdown file. You can share it with end users.