GWAPI: Overview

From Yombo
Jump to: navigation, search

The Gateway API allows off the shelf clients and tools to communicate directly with the Yombo Gateway to get device status, send commands, collect statistics, and more. The Gateway API can also be extended by various modules as well.

The API is uses the JSON API v1.1 specification to standardize inputs and outputs. The resource URI's are predictable in what you should get back or action requested of the API.

See also

Table of Contents

  • Authentication
    • API Auth Keys - Provide the API auth key with each request for access.
  • Provided resources
  • System
    • Awake - If the gateway is awake and fully started.
    • Uptime - Provides the time in seconds since the gateway was started.
This page was last edited on 12 April 2019.