Linksys Smart Wi-Fi API and SDK Documentation
Linksys Smart Wi-Fi APIs and SDK documentation provides release notes, API specifications, and other documentation for current and prior versions of our APIs and SDK. The SDK is a package that supports the development of applications that calls services and API functions to access Linksys Smart Wi-Fi Routers and their connected network devices.
API and SDK documentation ver. 1.4 was released 10/04/2012
The following major updates to the documentation were made:
The following major updates to the documentation were made:
|
Port Forwarding (Functionality Released) |
|
Get the metadata about single-port forwarding rules
Get all single-port forwarding rules
Add a single-port forwarding rule
Get a single-port forwarding rule
Update a single-port forwarding rule
Delete a single-port forwarding rule
Port Range Forwarding Rules
- Get the metadata about port range forwarding rules
- Get all port range forwarding rules
- Add a port range forwarding rule
- Get a port range forwarding rule
- Update a port range forwarding rule
- Delete a port range forwarding rule
These services and APIs allow developers to build browser and mobile-based software applications that provide remote access to Linksys Smart Wi-Fi Routers and their connected devices.
Cloud services are provided to developers that allow consumers to logon with their Linksys Account credentials. This is accomplished using the OAuth 2.0 framework for secure API authorization. OAuth provides a method for developers to grant third-party access to their resources without sharing their passwords. It also provides a way to grant limited access (in scope, duration, etc.). In addition, there are services that allow the
discovery of networks associated with a consumer's account.
Once a consumer has successfully logged in and selected their network, the developer can leverage a vast array of APIs that provide the tools to effectively manage the consumer's network environment and/or connected devices. These APIs are categorized into the following services:
|
Service Name
|
Description
|
|
Core Service
|
Exposes common device-level functionality and settings.
|
|
DDNS Service
|
Provides access to a device's DDNS settings.
|
|
Device List Service
|
Provides information about the devices that are connected to the network, as well as those that are not currently online but have been connected to the network in the past.
|
|
Diagnostic Service
|
Provides access to diagnostic tests.
|
|
Guest Network Service
|
Provides access to guest network settings on a wireless access point.
|
|
Guest Network Authentication
|
Provides a mechanism to authenticate a device for WAN access via the guest network interface .
|
|
Locale Service
|
Provides access to locale-related device properties and settings.
|
|
Network Connection Service
|
Returns information about the network connections between client devices and the network infrastructure device.
|
|
Parental Control Service
|
Provides access to a router's parental controls settings.
|
|
QOS Service
|
Provides access to Quality of Service settings on a router or other network infrastructure device.
|
|
Router Service
|
Provides access to basic router properties and settings.
|
|
Router LED Service
|
Provides access to a router's LED settings.
|
|
Router UPnP Services
|
Provides access to a router's UPnP settings.
|
|
Storage Service
|
Provides access to a device's mounted drives.
|
|
FTP Server
|
Provides access to a device's FTP folders.
|
|
SMB Server
|
Provides access to a device's SMB folders.
|
|
Storage
|
Provides access to a device's mounted partitions.
|
|
UPnP Media Server
|
Provides access to a device's UPnP media folders.
|
|
Wireless AP Services
|
Provides access to properties and settings of the 802.11 wireless access point.
|
|
WPS Server
|
Allows a client to start and stop WPS sessions on the wireless access point using a "soft" pushbutton method rather than a physical button on the access point.
|
|
WPS Server 2
|
Extends the WPSServer service, allowing a client to provision the WPS server settings on the wireless access point.
|
|
Wireless AP
|
Provides access to properties and settings of the 802.11 wireless access point.
|
The platform allows developers to leverage its services and APIs to build an endless number of multiplatform applications that provide remote access to a consumer's network and its connected devices.
SDK Documentation Resources
For information regarding the development environment please refer to the Linksys Smart Wi-Fi Platform Developer - Application Management Console. (This document is not currently available, but is coming soon!)