Scribd
Upload
9 views2 pages

Base - Url : S. No - Use Case Request Type URL Response

This document outlines 4 APIs for an IoT device onboarding platform: 1. A single device onboarding API that returns a script to provision a device. 2. An API to fetch a list of venues. 3. An API to fetch available IoT hubs. 4. An API to check device name availability that returns whether a name is available or not.

Uploaded by

avirup.banerjee.nagarro
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
9 views2 pages

Base - Url : S. No - Use Case Request Type URL Response

This document outlines 4 APIs for an IoT device onboarding platform: 1. A single device onboarding API that returns a script to provision a device. 2. An API to fetch a list of venues. 3. An API to fetch available IoT hubs. 4. An API to check device name availability that returns whether a name is available or not.

Uploaded by

avirup.banerjee.nagarro
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 2

base_url = https://iot-platform-avirup-functions.azurewebsites.

net/api/

Device Onboarding Page APIS

S. Use case Request URL Response


No type
.
1. Single POST/GET {
device {base_url}/ singledevice? "script": "sudo curl
onboardin deviceName=deviceName& deviceGroup= https://utilityavirup.blob.core.windows.ne
g deviceGroup&venue_id= venue_id t/script/test12.sh | sudo bash | tee
~/provision.log 2>&1"
}

https://iot-platform-avirup-
functions.azurewebsites.net/api/
singledevice?
deviceName=test11&deviceGroup=iot-
platform-avirup-iothub&venue_id=27bdac9b-
52e2-44ec-b00f-28954cbbe390
2. Fetch GET/POST [
Venue List {base_url}/venuelist {
"id": "0511b45e-846d-44b3-bcbc-
d11bf00b7daf",
"name": "Bestech Parkview - Anshul"
https://iot-platform-avirup- },
functions.azurewebsites.net/api/venuelist {
"id": "27bdac9b-52e2-44ec-b00f-
28954cbbe390",
"name": "Temporary Building"
},
{
"id": "b481c7bd-f204-41ac-beef-
041de60a9875",
"name": "Corporate Office Nagarro"
}
]
3. Fetch Hub GET/POST [
List {base_url}/hublist "iot-platform-avirup-iothub"
]

https://iot-platform-avirup-
functions.azurewebsites.net/api/hublist
4. check GET/POST For single
device {base_url}/checkdevicename?deviceList= [
name deviceList &deviceList=deviceList {
availability "device_name": "test1",
"availability": false
https://iot-platform-avirup- }
functions.azurewebsites.net/api/ ]
checkdevicename?
deviceList=test1&deviceList=test10
For bulk
[
{
"device_name": "test1",
"availability": false
},
{
"device_name": "test12",
"availability": true
}
]

You might also like