4 api, 1 enabling the api, 2 connecting to the api – Dovado 4GR User Manual

Page 20: 3 logging in to the api, 4 api syntax, Part 4, Enabling the api, Connecting to the api, Logging in to the api, Api syntax

Advertising
background image

T h e M o b i le C h o ic e f o r y o u r B r o a d b a n d I n t e r n e t

Reference Manual 6.2.6

20

© 2013 Dovado FZ-LLC

4

API

The Application Programmable Interface (API) allows you to create your own custom interface with
the router. You can control certain features such as Home Automation, as well as manage SMS
messaging.

4.1

Enabling the API

To enable the API please do the following.

LAN Access:
Go to System-> Remote Management
Click Enable LAN management
Click API Over LAN
Click GPS Over LAN

WAN Access:
Go to System-> Remote Management
Click Enable WAN management

Enter the IP address or hostname of the trusted client or check 'all' to enable WAN access for any
client. Tick in the API, HOME and SMS -boxes for Home Automation and SMS access for the
client.
Do not forget to reboot the router after activating the API.

4.2

Connecting to the API

The API operates on port 6435.

To connect you can for example, type in the following within a console:
telnet 192.168.0.1 6435 (or change 192.168.0.1 to the IP of your router).
If the connection was successful you will receive something similar to:

This is version X.Y of the API
SMS is enabled and HOMEAUTOMATION is enabled for you

Followed by a '>>'-prompt

4.3

Logging in to the API

The API uses the Username and Password as specified in the Web GUI.
To log in as user admin, type:

user admin

When prompted for a password, enter it using the following syntax:

pass password

(The password is the is configured unser SYSTEM->USERS)
If the login fails, control & re-enter your credentials until access is granted.

4.4

API Syntax

To display information about the GUI functions and syntax, type help.

Commands:

help (show this help)
exit|quit|bye (close the telnet session)
user [username] (log in as user)

Advertising