Linking Web API in DataSight

Linking Web API in DataSight

DataSight supports ingesting data from Web APIs. An API key is required to connect to the API Server in order to request the data. Currently DataSight supports requesting data (ie. a PULL operation) in an Automated Task, which requests data from the Web API, downloads the data file, and then imports the data into your database.

Third-party products, such as Postman®, can connect to for instance a LoRaWAN device using your API key and a Web API URL string to request and save data. This is useful for creating an Import Template if you do not already have a data file from the Web API available.

 

Web API URL String

When entering your File Name or Target location, the standard Web API URL string is in the format:

https://api:<YOUR API KEY>@<API END POINT>/<DEVICEID>/<COMMAND><OPTIONAL ARGUMENTS> (e.g. https://api:8a0892e3aedbe2f2ade4bd727d4725e0c639d021@www.nnnco.io/v2/api/sense/devices/532FC45327658E1234/readings?fromTs=last5hours)

Where:

  • <YOUR API KEY> is your unique API Key provided to you by the Web API hosting provider.
  • <API END POINT> is a combination of the address of the server hosting the API, and the version and type of API being 'called' (www.nnnco.io/v2/api/sense/devices).
  • <DEVICEID> is the ID of the LoRaWAN device you are requesting data for (532FC45327658E1234).
  • <COMMAND> is the command sent to the API for what data is being requested (readings).
  • <OPTIONAL ARGUMENTS> are optional arguments allowing you to further refine the dataset you are requesting (?fromTs=last5hours).

Note

Optional arguments may be beneficial to ensure that data is not missed depending on the frequency an automated Task has been configured to occur when ingesting data. Please contact your Web API hosting provider for a list of optional arguments available for their system.

When using a third-party product, such as Postman®, to request data from a Web API, it may be required for you to omit the 'api:<YOUR API KEY>@' section of the Web API URL string as this may be required to be entered separately.

 

See also:

  • LoRaWAN Device Import Routine
  • LoRaWAN Device Automated Import Task

    • Related Articles

    • Linking Web Service in DataSight

      Data can be automatically ingested into DataSight from a Web Service. Web Service URL String When entering your File Name or Target location, the Web Service URL string must be in the format of: http://<websiteaddress> or https://<websiteaddress>. ...

    • Linking URL String in DataSight

      You can link DataSight to systems, either local or on the cloud, via a URL string in any File Dialog window within DataSight. This allows you to download human readable files for import, or upload data and reports to these systems. The types of ...

    • Linking DataSight

      DataSight has been designed to ensure that data stored within DataSight can easily be shared or disseminated to other systems. Our design focuses on data management and pulling data in human readable format from instruments and other systems to ...

    • Web Browser

      The internal Web Browser can be used to access pages from the internet. Within the browser, you can also move backward and forward through web pages. Launch the Web Browser Make sure that your computer is connected to the internet and DataSight is ...

    • Web Browser Login

      DataSight Cloud can also be accessed by browsing a web link on any device connected to the internet. This opens a user connection page to the RAS where DataSight can be launched from. Click on the web link http://www.datasight.cloud/ to connect to ...