IOTICS WebAPI

Introduction

Welcome to the IOTICS WebAPI introduction section, over the next few pages we will go over a number of tutorials to get you from nothing to a working Digital Twin.

If you're planning on using Python then you may benefit from exploring the IOTICS Host Library first.

For these tutorials we will work towards creating a file called iotics_tutorial.py to create a twin enriched with metadata and a feed. You will be be able to share and retrieve the shared value as well as search for the twin you've made.

For ease of use we have broken the tutorials up into:

• Prerequisites
• Tutorial 1 - Make a heart beat device twin
• Tutorial 2 - Share and Subscribe to a feed
• Tutorial 3 - Searching
• Tutorial 4 - Adding properties

We recommend you run through the tutorials in order and you will also need to completed the Identity tutorial if you have not done so already.

If you'd like to have our API definition up as you follow the tutorial, take a look at our API Reference.

📘

Note:

Our API is also compatible with a number of OpenAPI Generation tools such as the OpenAPI Generator, enabling the generation of other language APIs.

Just follow their documentation to generate your relevant library, you can get our API's JSON by visiting your space's API json link. For example, if your space is https: examplespace.iotics.space then the URL you need would be: https://examplespace.iotics.space/qapi/openapi.json.