Skip to Content
APIExamples

API Examples

Practical examples for using the HyperDynamic Controller API.

Quick Start

JavaScript/Node.js

const API_KEY = 'your-api-key' const BASE_URL = 'https://api.hyperdynamic.cn/v1' async function getControllers() { const response = await fetch(`${BASE_URL}/controllers`, { headers: { 'Authorization': `Bearer ${API_KEY}`, 'Content-Type': 'application/json' } }) return response.json() }

Python

import requests API_KEY = 'your-api-key' BASE_URL = 'https://api.hyperdynamic.cn/v1' def get_controllers(): headers = { 'Authorization': f'Bearer {API_KEY}', 'Content-Type': 'application/json' } response = requests.get(f'{BASE_URL}/controllers', headers=headers) return response.json()

cURL

curl -X GET "https://api.hyperdynamic.cn/v1/controllers" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json"

Common Use Cases

Create and Start a Controller

// 1. Create controller const controller = await fetch(`${BASE_URL}/controllers`, { method: 'POST', headers: { 'Authorization': `Bearer ${API_KEY}`, 'Content-Type': 'application/json' }, body: JSON.stringify({ name: 'Production Controller', type: 'standard' }) }).then(r => r.json()) // 2. Send start command await fetch(`${BASE_URL}/controllers/${controller.id}/commands`, { method: 'POST', headers: { 'Authorization': `Bearer ${API_KEY}`, 'Content-Type': 'application/json' }, body: JSON.stringify({ action: 'start' }) })

Monitor Controller Status

async function monitorController(controllerId) { const response = await fetch( `${BASE_URL}/controllers/${controllerId}`, { headers: { 'Authorization': `Bearer ${API_KEY}` } } ) const data = await response.json() console.log(`Status: ${data.status}`) return data } // Poll every 5 seconds setInterval(() => monitorController('ctrl-123'), 5000)
Last updated on