Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Home
  • Knowledge base
  • Contact Us
  • Home
  • Developers
  • Shadow API

Shadow API (Proxy API to SIA)

How to utilize the internal API of SIA remotely using the Shadow API

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Getting started
    Introduction to SIA Technical info Portal - Web App (UI) SIA Connect as Software
  • Using SIA
    Connectors Instances Items Mapping Scripting & Variables Data
  • Connectors
    Siemens S7 Azure Ethernet/IP Mitsubishi MELSEC OPC-UA Server SQL MQTT Omron Host Link REST API Omron FINS Keyence Beckhoff TwinCAT BACnet Virtual OPC-UA Client MS SQL File
  • Developers
    API documentation Shadow API
  • Tutorials & Guides
    Azure IoT Hub Siemens S7 AWS IoT Core - Amazon Web Services Microsoft Power BI SIA Connect Demo Rack AVEVA Insight Azure IoT Central
+ More

Articles in this section:

  • Shadow API (Proxy API to SIA)
  • Using the Shadow API

Table of Contents

IntroductionDescription

Introduction

ShadowAPI is a tool that allows SIA to expose its internal API‍ using the MQTT protocol as a way to forward requests. 

It can help especially in situations where the user wants to access the API and SIA is running behind a firewall, or an environment with restricted HTTP access. Hence acting as a API proxy forwarder which allows remote access to the API.


For developer setup and use instructions, please follow this guide‍.


Description

In order to make use of the ShadowAPI, a MQTT Broker is required to which SIA needs to be able to connect to, either in the local network or the internet.

The MQTT broker configuration can be set on the SIA Web interface, under the tools section.

After setting up the MQTT broker fields, a connection to it should be successful.

Then, any queries can be sent to the MQTT broker (in a specific format) in order to interface with the SIA API. The ShadowAPI will listen to the MQTT broker, receive the query, process it and finally, return a response to the Broker.

There are 2 main types of channels (topics). One topic which is used by the client to send HTTP requests meant for the SIA API and another topic for the corresponding responses.

Every request reflects a message format which is described ShadowAPI‍ developer section. Responses follow the same exact format.


For developers

Read more detailed information regarding the technical use at the ShadowAPI‍ developer section.


Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • Using the Shadow API
  • API Reference

0
0
Expand