REST API Overview

Two Different APIs

Voodoo Robotics supports two different APIs for interacting with Pick-to-Light devices. Integration between your warehouse management system (WMS) or Enterprise Resource Management Solution (ERP) is easy.

• Recommended (REST API): For full-featured integrations, use the REST API with JSON payloads and standard HTTP methods. It supports device management, bulk operations, locations, orders, sequences, and closed-loop workflows.
• Fallback (QueryString GET): If you need the simplest possible integration, use a query string with a GET request. It works well for initial evaluation, one-device commands, and systems with limited HTTP capabilities, but it does not follow REST principles.

Base URLs

All API requests are made against one of two base URLs depending on your server deployment:

Core Endpoints

OpenAPI Specification

Index Request

Get a list of all devices in your account. Use a GET request on the endpoint /api/device/. You can use XML or JSON in your request.

Inspect Request

Once you have a particular DeviceID, you can get more information about that device (voltage, uptime, etc.). Use a GET request on the endpoint/api/device/FFFFFF:EEEEEE/.

Update Request

Update the message on a device. Use a POST request on the endpoint/api/device/FFFFFF:EEEEEE/.

Update Multiple Devices

Update multiple devices in one API call. Use a POST request on the endpoint /api/devices/ (note the plural). This saves time and resources by consolidating API calls. See the multiple devices FAQ entry for a worked example with the correct endpoint.

Most Simple Example

In just five lines of Python code, you can send a simple command to a device. Notice that the example uses a single requests.Session() object — reusing the same HTTP connection avoids paying the DNS, TCP, and TLS setup cost on every request. See the connection overhead FAQ entry for timing measurements and a deeper explanation.

import requests, json

session = requests.Session()
url = "https://www.voodoodevices.com/api/"

x = session.post(url + "user/login/",
    json={'username': 'yourusername', 'password': 'yourpassword'})
z = json.loads(x.text)

session.post(
    url + "device/E8D008:619874/",
    headers={'referer': url, 'x-csrf-token': z['token']},
    json={'command': 'flash', 'line1': 'Hello', 'line2': 'There', 'seconds': 60},
)

Step-by-Step Example

A more complete example demonstrating device info retrieval, device listing, and messaging:

import requests

API_KEY = 'your_api_key_here'
url = 'https://www.voodoodevices.com/api/'

headers = {
    'API-KEY': f'{API_KEY}',
    'Content-Type': 'application/json',
}

def get_device_info(device_id):
    """Retrieve all Cloud Display Device attributes from Big Block."""
    response = requests.get(f"{url}device/{device_id}/", headers=headers)
    return response.json()

def get_device_list():
    """Return a list of all Device IDs in Big Block."""
    response = requests.get(f"{url}device/", headers=headers)
    return response.json()

def send_message(device_id, line1, line2, color='r', seconds=60):
  """Send a simple two-line message to a device."""
  data = {
    'command': 'flash',
    'line1': line1,
    'line2': line2,
    'color': color,
    'seconds': seconds,
  }
    response = requests.post(f"{url}device/{device_id}/", headers=headers, json=data)
    return response.json()

# Usage examples:
# device_info = get_device_info('D4E825:8B665D')
# device_list = get_device_list()
# send_message('D4E825:8B665D', 'Take 5', 'Red Widgets', color='r')

Inspect Turbos

Similar to the device endpoint, you can use the turbo endpoint to get information about your Turbos. Use a GET request on/api/turbo/ or/api/turbo/SERIALNO/.

# List all Turbos
response = requests.get(f"{url}turbo/", headers=headers)
turbos = response.json()

# Get info for a specific Turbo
response = requests.get(f"{url}turbo/1000044044404/", headers=headers)
turbo_info = response.json()