API principles

There are certain APIs for which IMPACT IoT does not require interaction with the devices, all those operations will be synchronous that is, IMPACT IoT will not respond with a correlation Id but returns the final result immediately. Some examples include:
  • Enterprise application registration
  • Delete subscriptions to resources and lifecycle events
  • Read all subscriptions to resources and lifecycle events
  • Read single subscription to resources and lifecycle events
  • Add serial numbers
  • Delete serial numbers
  • View serial numbers
  • List endpoints
There are other APIs which require interaction with the devices, all those operations will be asynchronous. For such APIs, endpoint's responses arrive in the notification channel. An HTTP/HTTPS request will return immediately with a correlation ID (Subscription ID for observing resources, Request ID for single operation on a single resource). Some examples include:
  • Read, write, delete, execute resource
  • Subscription to resources / life cycle events
  • Get endpoint details
Further sections of this document will explain more about these APIs.
Note:
  • IMPACT IoT APIs are device and protocol agnostic. Reference to LWM2M in this document is only for illustration purpose and to provide the users of this guide an overview of the working of these APIs.
  • Resource path for devices may differ for different device and protocol types. In general, resource path refers to the address of the resource on which you want to perform the read, write, execute, and delete operations. Depending on the protocol in use, its value can either be an integer (as in the case of LWM2M) or a complex structure.