HotSpot Integration Setup 2018-04-15T09:58:59+00:00

HotSpot Integration With Your Website or App

Automate login and logout, remotely create or manage accounts, get price plans, account statistics and more

Easy integrate login in your website

Learn easy and advanced methods for HotSpot integration with your website or application.
HotSpot login can be initiated from your website.

To make this integration, please check the code below:

<FORM method=”post” ACTION=”http://192.168.0.1/login” >
USERNAME<BR \>
<input name=”userlogin”><BR \>
PASSWORD<BR \>
<input name=”userpass” type=”password”><BR \>
<input value=”LOGIN” name=”Login” type=”submit” />
</FORM>

This code inserts two fields and a button in your website. It sends a username and a password to the HotSpot for user authentication.

If the login is successful, a welcome page will be displayed to the user.

To customize this code example for your HotSpot, please replace IP address 192.168.0.1 with the real HotSpot IP or hotspot URL (if you have domain tied to your IP).

You can also assign css styles to the fields and the button, edit words etc.

HotSpot software API Integration

HotSpot’s powerful application programming interface (API) helps you integrate it with third-party software to control and manage accounts, get statistics and price plans, automate billing for your customers.

API commands lets you create, update and delete accounts, login or logout desired account, get account summary, or even pull entire list of active accounts.

Our API is easy to implement using REST HTTP GET query and XML response, and it can be customized per your needs.

Integration with your software works this way:

  • Your software should send a formatted query similar to URL you type in browser to see certain web page

  • HotSpot software gets this query, parse it and execute the actions (example: generate accounts)

  • HotSpot software generate XML response with details (example: account details) and return it to your softwarechanges, use your own WiFi hardware

  • Your software parse XML and process the data (example: use account details to print receipt)

You can activate and configure API settings on HotSpot Setup – Options – API Integration page. To activate this feature please check Enable Integration, specify port (82 by default), and Secret PassPhrase.

Purpose of the PassPhrase is to protect from unauthorized usage while allowing you to use integration commands from different IP addresses.

For example, multiple instances of your program can communicate with HotSpot and generate accounts.

API Integration Examples

ACCOUNT LOGIN
Login account TEST with desired parameters for download, upload, quota …

http://192.168.0.1:82/loginaccount?account=TEST&ip=192.168.1.123&mac=00-11-22-33-44-55&time=3600″a=1024000000&download=102400&upload=102400&inactivity=1&pass=PASS

ACCOUNT LOGOUT
Logout specified account

http://192.168.1.155:82/logoutaccount?account=TEST&pass=SECRETPASS

GENERATE ACCOUNTS
This command will generate 5 accounts and assign price plan 1 to those accounts. You can put a button in your software and send such command after user click on it. XML response contains all account data, like username, password, time, quota, expiration.

http://192.168.0.1:82/generateaccounts?number=5&priceplan=1&pass=PASS

GET ALL PRICE PLANS TO LIST IN YOUR SOFTWARE
This command is used to retrieve all price plans from HotSpot software. XML response will contain price plan description, cost, time and quota values, expiration etc. You can use these details to store them in your controls (like Listbox, Combobox) and allow a customer to choose a price plan before you send command to generate the accounts.

http://192.168.0.1:82/getpriceplans?pass=PASS

GET ACCOUNT DETAILS
This command is used to retrieve usage statistics (used time, bandwidth, sales value) for the account “TEST”.

http://192.168.0.1:82/getaccountsummary?account=TEST&pass=PASS

Complete API Example
Generate 1 account with price plan No 2 (command sent to HotSpot)

http://192.168.1.155:82/generateaccounts?number=1&priceplan=2&pass=PASS

XML RESPONSE: (Received by HotSpot – This is what you parse to get data)

<!ELEMENT Account ((Username,Password,TimeUsed,TimeLeft,UnlimitedTime,Quota, UnlimitedQuota,GroupPlanID,AccessFromTo,AccessID,Expire,ExpireIn,ExpireAfter, EnableDailyTime,DailyTime,EnableDailyQuota,DailyQuota,EnableDailyLogins, DailyLogins,Download,Upload,GenerateID ))>
<!ELEMENT Username (#PCDATA)>
<!ELEMENT Password (#PCDATA)>
<!ELEMENT TimeUsed (#PCDATA)>
<!ELEMENT TimeLeft (#PCDATA)>
<!ELEMENT UnlimitedTime (#PCDATA)>
<!ELEMENT Quota (#PCDATA)>
<!ELEMENT UnlimitedQuota (#PCDATA)>
<!ELEMENT GroupPlanID (#PCDATA)>
<!ELEMENT AccessFromTo (#PCDATA)>
<!ELEMENT AccessID (#PCDATA)>
<!ELEMENT Expire (#PCDATA)>
<!ELEMENT ExpireIn (#PCDATA)>
<!ELEMENT ExpireAfter (#PCDATA)>
<!ELEMENT EnableDailyTime (#PCDATA)>
<!ELEMENT DailyTime (#PCDATA)>
<!ELEMENT EnableDailyQuota (#PCDATA)>
<!ELEMENT DailyQuota (#PCDATA)>
<!ELEMENT EnableDailyLogins (#PCDATA)>
<!ELEMENT DailyLogins (#PCDATA)>
<!ELEMENT Download (#PCDATA)>
<!ELEMENT Upload (#PCDATA)>
<!ELEMENT GenerateID (#PCDATA)>
]>

<Accounts>

<Account>

<Username>TEST2</Username>

<Password>NEWPASS</Password>

<TimeUsed>0</TimeUsed>

<TimeLeft>3720</TimeLeft>

<UnlimitedTime>False</UnlimitedTime>

<Quota>0</Quota>

<UnlimitedQuota>True</UnlimitedQuota>

<GroupPlanID>2</GroupPlanID>

<AccessFromTo>False</AccessFromTo>

<AccessID>0</AccessID>

<Expire>2012-11-10 19:33:45</Expire>

<ExpireIn>1</ExpireIn>

<ExpireAfter>1</ExpireAfter>

<EnableDailyTime>False</EnableDailyTime>

<DailyTime>0</DailyTime>

<EnableDailyQuota>False</EnableDailyQuota>

<DailyQuota>0</DailyQuota>

<EnableDailyLogins>False</EnableDailyLogins>

<DailyLogins>0</DailyLogins>

<Download>131072</Download>

<Upload>65536</Upload>

<GenerateID>16</GenerateID>

</Account> </Accounts>

Your application should parse this XML data to get information sent by HotSpot. From the example, you can see that the generated account has username TEST2 and password NEWPASS.

Try it Free

  • Technical support to get setup fast and easy.

  • Learn the powerful management features.

  • Buy it when you are convinced we are the best.

DOWNLOAD FREE TRIAL

Buy Your License

  • No reinstallation. Keep all your configurations.

  • License is good forever. Free updates until next major release.

  • Technical support: Email, Phone, Online chat

BUY NOW

Our customers

Download Free Trial and Test HotSpot Software Now!
We’re here to help.

We’ll help you configure everything
Technical support: Email, Phone, Online chat
No obligations, zero-risk free trial