Onwords Gate Control API — Documentation

Example Flow

1. 1
   Visit https://ostapi.onwords.in and click on "Get API Key" from the menu.
2. 2
   You'll be redirected to the login page. Enter your email and password, then click Submit.
3. 3
   After logging in, you'll see a list of your devices. Select the devices you want to generate the API key for.
4. 4
   Click the "Generate API Key" button. Your new API key will be displayed. Copy and save it securely.

Description

This endpoint is used to generate a secure API Key via the Onwords Smart Things app. Upon key generation, the API securely stores and associates the API key with the selected product(s), enabling authorized access for future device control operations.

Before controlling any devices, you need to retrieve the list of devices associated with your API key. This endpoint returns all devices you have access to, along with their unique identifiers and types.

Endpoint:

Description:

This endpoint authenticates your API key and returns a list of all devices you have permission to control. Each device includes essential information such as the product ID, device name, gate type, and current status.

📋 Request Headers

📊 Response Format

{
  "product_ids": ["device_001"],
  "status": "success",
  "api-key": "abcd123"
}

💻 Example Implementation

import requests

# Your API configuration
API_KEY = "your_api_key_here"
BASE_URL = "https://ostapi.onwords.in/"

def get_device_list():
    headers = {
        "Authorization": f"Bearer {API_KEY}"
    }
    
    response = requests.post(
        f"{BASE_URL}get_device_list",
        headers=headers
    )
    
    return response.json()

# Get device list
devices = get_device_list()
print(devices)

const API_KEY = "your_api_key_here";
const BASE_URL = "https://ostapi.onwords.in/";

async function getDeviceList() {
    const response = await fetch(`${BASE_URL}get_device_list`, {
        method: 'POST',
        headers: {
            'Authorization': `Bearer ${API_KEY}`
        }
    });
    
    return await response.json();
}

// Get device list
getDeviceList()
    .then(result => console.log(result))
    .catch(error => console.error('Error:', error));

Endpoint:

Description:

Authenticates the user, validates the API key and product access, and sends control commands to the selected device. This endpoint supports various gate types and provides real-time device control capabilities.

📋 Request Headers

🎯 Supported Device Types & Actions

📝 Request Body Format

{
  "product_id": "your-product-id",
  "action": "open"
}

📊 Response Format

{
  "status": "success",
  "product_id": "your-product-id",
  "gate_type": "your-gate-type"
}

💻 Example Implementation

import requests

# Your API configuration
API_KEY = "your_api_key_here"
BASE_URL = "https://ostapi.onwords.in/"

def device_action(product_id, action):
    headers = {
        "Authorization": f"Bearer {API_KEY}",
        "Content-Type": "application/json"
    }
    
    data = {
        "product_id": product_id,
        "action": action
    }
    
    response = requests.post(
        f"{BASE_URL}control-device/",
        json=data,
        headers=headers
    )
    
    return response.json()

# Control device
status = device_action("device_123", "open")
print(status)

const API_KEY = "your_api_key_here";
const BASE_URL = "https://ostapi.onwords.in/";

async function deviceAction(productId, action) {
    const response = await fetch(`${BASE_URL}control-device/`, {
        method: 'POST',
        headers: {
            'Authorization': `Bearer ${API_KEY}`,
            'Content-Type': 'application/json'
        },
        body: JSON.stringify({
            product_id: productId,
            action: action
        })
    });
    
    return await response.json();
}

// Control device
deviceAction("device_123", "open")
    .then(result => console.log(result))
    .catch(error => console.error('Error:', error));

# Get Device List
curl -X POST https://ostapi.onwords.in/get_device_list \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json"

# Control Device
curl -X POST https://ostapi.onwords.in/control-device/ \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "device_123",
    "action": "open"
  }'