Getting started

Testing instance

For demo and testing purposes Yggio Sandbox is available. It's open for anyone to create an account and start using. The Yggio Sandbox control panel is available at: https://portal.yggio-sandbox.sensative.net/. Note that this instance runs the latest Yggio version which means that breaking changes may occur and the database may occasionally be cleared. Thus, we recommend not using this instance for production purposes.

The REST API is documented in our Swagger. There you can try out all the different requests.

Production instance

If you've decided to go live there are different options on how to proceed. You can either use the public instance ygg.io, we can host a dedicated Yggio for you or you can host an instance yourself. Please contact us at info@sensative.com for more information.

Creating your application

Talking to Yggio

Your application will be interfacing with two parts of Yggio: the REST API and the publisher. The REST API can be used to get, create, update and delete model entities, such as iotnodes, users, providers, etc. The publisher can be used by your application to receive push updates when iotnodes change. For this your application will need to be able to either receive HTTP POST requests or subscribe to our MQTT broker. See the publisher page for more information.

Using the SDK

Your application can of course be written in the language of your choosing. However, if you use Node.js, you can make use of our public SDK which provides ready-to-use functions facing the REST API. For more information visit the SDK page.

OAuth

OAuth is used to authorize your application and it requires your application to have a backend. Your application will need to have OAuth support implemented. See the OAuth page for more information.

Creating a provider

In Yggio an application is represented as a provider. To connect your application to Yggio you will have to create a provider entity. This enables your application to authorize itself with OAuth in order to use the REST API, as well as enabling it to receive updates from the publisher.