Getting started

Production instance

If you've decided to go live there are different options on how to proceed. We can host a dedicated Yggio for you or you can host an instance yourself. Please contact us at for more information.

Creating your application

Talking to Yggio

Your application will be interfacing with two or three parts of Yggio: NGSIv2 API, REST API and the publisher. The NGSIv2 API or REST API can be used to get, create, update and delete entities, while the REST API can be used for users, managing external applications, rules, etc. NGSIv2 API or the publisher can be used by your application to receive push updates when entities change. For this your application will need to be able to either receive HTTP POST requests or subscribe to our MQTT broker (only publisher). 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.

OpenID Connect

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

Creating an application

In Yggio an application is represented as an OpenID Connect RP (Relying Party). To connect your application to Yggio you will have to create an RP. This enables your application to authorize itself with OpenID Connect in order to use the APIs, as well as enabling it to receive updates from the publisher.