developer.yonomi.co Open in urlscan Pro
2606:4700::6812:d238  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Jump to Content

GuidesAPI ReferenceUpdates

--------------------------------------------------------------------------------

Guides


Guides
Welcome
Search
CTRL-K
OverviewWelcomeSelf-Guided API TourUser SetupWorking with DevicesUnderstanding
Device TypesAdding 3rd-Party DevicesDevice ControlWorking with RoutinesLocations
& Location-Triggered RoutinesUsing the Yonomi Account DeviceWrapping UpGetting
StartedField InputsAPI ReferenceUsing Yonomi OneRoutines3rd-Party Account
ConnectionAdvanced YO ConceptsUsing LocationsAuthAuthorization and
AuthenticationTraits (Beta)Traits OverviewAction Request GuideRoutines
GuideTraits ReferenceDatatype ReferenceDevicetype ReferenceError
ReferenceWebhooksYonomi One WebhooksOtherBest Practices and ResourcesDevice &
Account IconsExternal ResourcesOnboarding WorkshopSupportFrequently Asked
QuestionsSupportOther Yonomi PlatformsYonomi Platform Developer PortalYonomi
Platform Self-Guided API TourYonomi Platform Tenant Configuration Guide
All
Guides
Reference
Updates
Pages

START TYPING TO SEARCH…


OVERVIEW

 * Welcome
 * Self-Guided API Tour
   * User Setup
   * Working with Devices
   * Understanding Device Types
   * Adding 3rd-Party Devices
   * Device Control
   * Working with Routines
   * Locations & Location-Triggered Routines
   * Using the Yonomi Account Device
   * Wrapping Up
 * Getting Started
 * Field Inputs
 * API Reference


USING YONOMI ONE

 * Routines
 * 3rd-Party Account Connection
 * Advanced YO Concepts
   * Using Locations


AUTH

 * Authorization and Authentication


TRAITS (BETA)

 * Traits Overview
 * Action Request Guide
 * Routines Guide
 * Traits Reference
   * Datatype Reference
   * Devicetype Reference
   * Error Reference


WEBHOOKS

 * Yonomi One Webhooks


OTHER

 * Best Practices and Resources
 * Device & Account Icons
 * External Resources
   * Onboarding Workshop


SUPPORT

 * Frequently Asked Questions
 * Support


OTHER YONOMI PLATFORMS

 * Yonomi Platform Developer Portal
 * Yonomi Platform Self-Guided API Tour
 * Yonomi Platform Tenant Configuration Guide

Powered by 


WELCOME

Suggest Edits

WELCOME TO YONOMI ONE

This documentation covers Yonomi v1 Platform APIs. If you are looking for
information about the Yonomi Platform API — the latest platform — you can find
it here.

The Yonomi One API allows you to integrate the power and capabilities of the
Yonomi platform directly into your own applications and services. Yonomi's
device automation and control, routines, recommendations, and on-demand device
state visibility can all be leveraged using the Yonomi One API.

Our Self-Guided Tour will walk you through using the Yonomi One APIs.


YONOMI ONE APIS

Yonomi One has three APIs: the Core API, the Auth API, and the Data API.


CORE API

The Core API is used for most of the calls you will make to interact with
devices, including controlling devices, accessing device state data or running
routines. For more detail on using the core API please see the Getting Started
section.


AUTH API

The Auth API is used to obtain access tokens and refresh tokens. Access tokens
are used for all authenticated calls against the core API. Access tokens are
also used in brokering authentication and authorization between a user and
3rd-party device provider clouds. Refresh tokens are used to refresh expired
access tokens, which have a default lifetime of 24 hours from last use. Access
tokens are generated in order to authorize 3rd-party devices to have a 2-minute
lifetime and cannot be refreshed. Refresh tokens don't expire, but each refresh
token can only be used once. For more detail on the Auth API, please see the
Retrieving an OAuth access token section.


DATA API

The Data API (beta, not available to all customers) provides access to
historical device state data, such as the historical temperature of a
thermostat, motion-detected events from a motion sensor, or historical light
actions. The Data API relies on state information being surfaced to Yonomi
either implicitly through execution of events or explicitly using API state
requests. The Data API is available on-demand - please speak with your Yonomi
representative to gain access to Data API documentation.


API URIS

The Core API URI is https://api.yonomi.co

The Auth API URI is https://auth.yonomi.co

The Data API URI is https://data.yonomi.co

 * Yonomi One APIs are always improving and being updated. Please check the
   Updates page for recent updates to the platform and documentation.
 * Provided you have a valid OAuth client_id and client_secret, and a valid
   tenant_id, you can make requests on any environment to which you have
   permission.


API VERSIONING

Yonomi One APIs are versioned.

 * API request versions are tracked through a request header of Accept-Version.
 * If you do not supply a version header in the request, it will default to the
   highest currently supported API version, currently v1.0.0.
 * If you provide an invalid version header it will return an error response.
 * Responses will include an Accept-Version version header matching the API
   version used to process the request.


REQUESTS AND RESPONSES

Yonomi One APIs are generally RESTful and work over HTTPS.


REQUEST VERBS

Request verbs used are:

 * POST
 * GET
 * DELETE
 * PUT (Some endpoints)

Note that PATCH is not used.

Since the API is RESTful, you can expect requests to follow this pattern:

 * Creating a resource: POST to /<resource>
 * Getting all resources: GET to /<resource>
 * Getting a single resource: GET to /<resource>/<id>
 * Updating a resource: PUT to /<resource>/<id>
 * Deleting a resource: DELETE to /<resource>/<id>


DATA FORMAT

 * Unless Specified, all media returned and consumed is JSON.
 * The Content-Type header should be to application/json
 * The Accept header should be to application/json

Note that some requests require an X-Request-Key to identify the source of the
request.


ERROR RESPONSES

The platform returns appropriate status codes where applicable and returns a
JSON body. Some resources may still return a string response body at this time.

JSON
{
  "error": {
    "type": "<error type>",
    "message": "A human-readable message about the error."
  }
}


Updated 7 months ago

--------------------------------------------------------------------------------

What’s Next

To begin working with Yonomi One APIs, try our self-guided API tour

 * Self-Guided API Tour

Did this page help you?
Yes
No
 * Table of Contents
 * * Welcome to Yonomi One
   * Yonomi One APIs
     * Core API
     * Auth API
     * Data API
   * API URIs
   * API Versioning
   * Requests and Responses
   * Request Verbs
   * Data Format
   * Error Responses