IoT Telemetry Interface
ArubaWLANWireless Local Area Network. WLAN is a 802.11 standards-based LAN that the users access through a wireless connection.provides publicIoT物联网。IoT refers to the internetworking of devices that are embedded with electronics, software, sensors, and network connectivity features allowing data exchange over the Internet.telemetry services to clients, such as location services,IoT物联网。IoT refers to the internetworking of devices that are embedded with electronics, software, sensors, and network connectivity features allowing data exchange over the Internet.applications, etc. These services aresubscriptionA business model where a customer pays a certain amount as subscription price to obtain access to a product or service.based. To subscribe to a telemetry service, create a transport profile on acontrolleror anInstant AP. For anIoT物联网。IoT refers to the internetworking of devices that are embedded with electronics, software, sensors, and network connectivity features allowing data exchange over the Internet.transport profile to function, the user should be authenticated and authorized. Refer to theArubaOS8.6.0.x User Guidefor more detail on creating anIoT物联网。IoT refers to the internetworking of devices that are embedded with electronics, software, sensors, and network connectivity features allowing data exchange over the Internet.transport profile.
Authentication and Authorization
To authenticate a user, configure an authenticationURLUniform Resource Locator. URL is a global address used for locating web resources on the Internet., username, and password in theIoT物联网。IoT refers to the internetworking of devices that are embedded with electronics, software, sensors, and network connectivity features allowing data exchange over the Internet.transport profile. If user authentication is not required, leave theURLUniform Resource Locator. URL is a global address used for locating web resources on the Internet., username, and password fields blank.
To authorize a user, provide an access token that is present in the message sent to the server. In an authenticated connection, the access token is obtained during the authentication process. In an unauthenticated connection, the access token should be configured manually in theIoT物联网。IoT refers to the internetworking of devices that are embedded with electronics, software, sensors, and network connectivity features allowing data exchange over the Internet.transport profile.
Authentication of a user is an optional procedure. |
Authentication Request
The following is theJSONJavaScript Object Notation. JSON is an open-standard, language-independent, lightweight data-interchange format used to transmit data objects consisting of attribute–value pairs. JSON uses a "self-describing" text format that is easy for humans to read and write, and that can be used as a data format by any programming language.content of theHTTPSHypertext Transfer Protocol Secure. HTTPS is a variant of the HTTP that adds a layer of security on the data in transit through a secure socket layer or transport layer security protocol connection.POSTPower On Self Test. An HTTP request method that requests data from a specified resource.operation for authentication request:
{
“grant_type” : “password”
“username” :
“密码”:<密码>
“client_id”:
}
Set “grant_type” to “password”.
“user_name”, “password”, and “client_id” are taken from theIoT物联网。IoT refers to the internetworking of devices that are embedded with electronics, software, sensors, and network connectivity features allowing data exchange over the Internet.transport profile.
If the client ID is not configured in theIoT物联网。IoT refers to the internetworking of devices that are embedded with electronics, software, sensors, and network connectivity features allowing data exchange over the Internet.transport profile, the “client_id” field will be disabled.
Authentication Response
The followingJSONJavaScript Object Notation. JSON is an open-standard, language-independent, lightweight data-interchange format used to transmit data objects consisting of attribute–value pairs. JSON uses a "self-describing" text format that is easy for humans to read and write, and that can be used as a data format by any programming language.content is displayed in the response body when the authentication is successful:
{
"access_token":
"token_type":"bearer",
"expires_in":2592000,
"api_url":
}
“access_token” is mandatory.
“token_type” is optional. If applicable, enter “bearer” as the value.
“expires_in” is optional. If not present, the token is held valid until an error occurs.
“apiApplication Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software._urlUniform Resource Locator. URL is a global address used for locating web resources on the Internet.” is optional. If present, use the value against theAPIApplication Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software.URLUniform Resource Locator. URL is a global address used for locating web resources on the Internet.specified in theIoT物联网。IoT refers to the internetworking of devices that are embedded with electronics, software, sensors, and network connectivity features allowing data exchange over the Internet.transport profile.
HTTPS API calls:
TheHTTPSHypertext Transfer Protocol Secure. HTTPS is a variant of the HTTP that adds a layer of security on the data in transit through a secure socket layer or transport layer security protocol connection.APIApplication Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software.call usesHTTPSHypertext Transfer Protocol Secure. HTTPS is a variant of the HTTP that adds a layer of security on the data in transit through a secure socket layer or transport layer security protocol connection.POSTPower On Self Test. An HTTP request method that requests data from a specified resource.only. In every call, the following access token is included in the authentication header:
"Authorization: Bearer
Error Handling
The authentication and authorization processes throw the following error:
401- Unauthorized: When this error is displayed, the system tries to reauthenticate the process.
Web socket API:
The "access_token" is included in payload, refer the telemetry prototype file for the exact definition.
Additional API support
Starting fromArubaOS8.4.0.0, the NBAPIApplication Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software.supports the followingJSONJavaScript Object Notation. JSON is an open-standard, language-independent, lightweight data-interchange format used to transmit data objects consisting of attribute–value pairs. JSON uses a "self-describing" text format that is easy for humans to read and write, and that can be used as a data format by any programming language.and proto files:
