Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1.72 KB

readme.md

File metadata and controls

38 lines (26 loc) · 1.72 KB
Raw

Create a custom API endpoint

If you want to provide some external partners/users with your Insights Hub data though a customizable API endpoint, this is how you get started on this. The example shows how you can

  • specify a dedicated Insights Hub RestAPI endpoint
  • select the method the endpoint should support (GET, PUT, POST, DELETE)
  • choose who has access to this endpoint (only users of the flow, all users on the tenant, public access)
  • develop the API functionality using VFC nodes

This flow demonstrates a simple getting-started example on how to provide machine data via an API for external access of the last 15min interval of machine data as JSON object. image

Setup & Configuration

  1. Import the flow in Visual Flow Creator
  2. Setup the API endpoint in the HTTP-IN node (blue node)
    • enter you custom endpoint-URL
    • choose endpoint access
    • generate key in case of public API access
    • the URL shown in the node setup is the direct URL to access the service image
  3. Select an Asset / Aspect / Variable(s) where you want to read the time series data from (yellow node) image
  4. Save the flow

Service-URL: The URL to access the endpoint can be found in the HTTP IN node and has the schema as follows
https://[TenantName]-visualflowcreatorhttp.eu1.mindsphere.io/public/presiot/machinedata/v1?key=[generatedKey]

☁️ ✔️ You're ready to access the service via the URL shown in the HTTP IN node - enjoy!

Result

When querying the service URL e.g. via a Browser/Postman/Python/... the JSON-object with the timeseries data will be received. image