IronWifi

FREE
By ironwifi
Updated a month ago
Business Software
4.8/10
Popularity Score
519ms
Latency
11%
Success Rate

IronWifi API Documentation

IronWifi offers a powerful Application Program Interface (API) that can be used to integrate IronWifi RADIUS authentication services with user and guest management systems.

The API framework allows your platform to interact with the network access control platform provided by IronWifi.

With the IronWifi API, user management systems can dynamically update the RADIUS server to instantly create or delete users in the IronWifi database, and you can set or modify access rights.

When a user attempts to access the network, IronWifi uses the updated credentials as the basis for permitting activities on the network.

When a user attempts to access a WiFi network, the Access Point can send a RADIUS request to IronWifi RADIUS. IronWifi authenticates the user based on the updated credentials.

To receive technical assistance with your IronWifi API project, or to discuss any advanced requirements that you may have, please contact us at [email protected], or call +1 (800) 963-6221.

View API Details
Account
PATCHCHANGE FULL NAME
PATCHCHANGE EMAIl/USERNAME
PATCHCHANGE PHONE
PATCHCHANGE PASSWORD
PATCHCHANGE SECURITY QUESTION/ANSWER
PATCHCHANGE TIMEZONE
PATCHCHANGE ORGANIZATION NAME/COMPANY
POSTADD PAYMENT CARD 2
POSTADD PAYMENT CARD 1
PATCHCHANGE PLAN
POSTADD TEAM MEMBER
DELETEDELETE TEAM MEMBER
POSTDELETE ACCOUNT
GETREAD ACCOUNT
PATCHEDIT EMAIL TOKEN
PATCHEDIT EMAIL FROM ADRESS
PATCHEDIT EMAIL FROM NAME
PATCHEDIT EMAIL CATEGORY SUBJECT
PATCHEDIT EMAIL CATEGORY ID
PATCHEDIT BILLING TAX STATUS
PATCHEDIT BILLING TAX VAT ID
PATCHEDIT BILLING TAX EMAIL
PATCHEDIT BILLING TAX ADDRESS
Token
GETMANUAL TOKEN LIST
POSTMANUAL TOKEN ADD
DELETEMANUAL TOKEN DELETE
Networks
POSTADD NETWORK
GETREAD NETWORK
PATCHCHANGE NETWORK NAME
PATCHCHANGE NETWORK SSID
PATCHCHANGE NETWORK REGION
DELETEDELETE NETWORK
GETREAD NETWORKS
Access Points
PATCHCHANGE ACCESS POINT NAME
PATCHCHANGE ACCESS POINT DESCRIPTION
PATCHCHANGE ACCESS POINT NETWORK
PATCHCHANGE ACCESS POINT MAC
PATCHCHANGE ACCESS POINT LOCATION
PATCHCHANGE ACCESS POINT APPROVAL
PATCHCHANGE OWNER NAME
PATCHCHANGE OWNER EMAIL
PATCHCHANGE OWNER PHONE
DELETEDELETE ACCESS POINT
GETREAD ACCESS POINTS
GETREAD ACCESS POINT
Captive Portals
POSTADD CAPTIVE PORTAL
GETREAD CAPTIVE PORTAL
PATCHCHANGE CAPTIVE PORTAL NAME
PATCHCHANGE CAPTIVE PORTAL DESCRIPTION
PATCHCHANGE CAPTIVE PORTAL NETWORK
PATCHCHANGE CAPTIVE PORTAL LANGUAGE
PATCHCHANGE CAPTIVE PORTAL SUCCESS
PATCHCHANGE CAPTIVE PORTAL CDN
PATCHCHANGE CAPTIVE PORTAL ANALYTICS
PATCHCHANGE CAPTIVE PORTAL COOKIE AUTH
POSTADD HOTSPOT PAID PLAN
PATCHCHANGE HOTSPOT PLAN
DELETEDELETE HOTSPOT PLAN
PATCHCHANGE GUEST USERNAME TYPE
PATCHCHANGE GUEST USERNAME LENGHT
PATCHCHANGE GUEST PASSWORD TYPE
PATCHCHANGE GUEST PASSWORD LENGTH
PATCHCHANGE GUEST EXPIRE ACTION
PATCHCHANGE GUEST EXPIRE TIME
GETREAD CAPTIVE PORTALS
Users
GETREAD USERS
POSTADD USER
PATCHCHANGE USER NAME
PATCHCHANGE FIRSTNAME
PATCHCHANGE LAST NAME
PATCHCHANGE EMAIL
PATCHCHANGE ORGANISATION
PATCHCHANGE AUTH SOURCE
PATCHDISABLE USER
DELETEENABLE USER
POSTADD USER LOGIN TIME
PATCHCHANGE USER LOGIN TIME
DELETEDELETE USER LOGIN TIME
POSTADD GROUP
POSTADD CERTIFICATE
PATCHREVOKE CERTIFICATE
DELETEDELETE CERTIFICATE
DELETEDELETE GROUP
POSTADD ATTRIBUTE
PATCHCHANGE ATTRIBUTE
DELETEDELETE ATTRIBUTE - RADCHECK
DELETEDELETE ATTRIBUTE - RADREPLY
DELETEDELETE USER
GETREAD USER
Groups
POSTADD [G]GROUP
PATCHCHANGE GROUP NAME
PATCHCHANGE GROUP DESCRIPTION
GETREAD GROUP
POSTDISABLE GROUP
DELETEENABLE GROUP
POSTADD MEMBER
DELETEDELETE MEMBER
POSTADD [G]ATTRIBUTE
PATCHCHANGE [G]ATTRIBUTE
DELETEDELETE ATTRIBUTE RADGROUPCHECK
DELETEDELETE ATTRIBUTE RADGROUPREPLY
DELETEDELETE [G]GROUP
GETREAD GROUPS
Organizational Units
POSTADD ORGUNIT
POSTADD [O]ORGUNIT
PATCHCHANGE ORGUNIT NAME
GETREAD ORGUNITS
PATCHCHANGE CONSOLE ACCESS
POSTADD [O]GROUP
DELETEDELETE [O]GROUP
DELETEDELETE [O]ORGUNIT
GETREAD ORGUNIT
Reports
GETREAD - AUTH REQUESTS 1
GETREAD - AUTH REQUESTS 2
GETREAD - ACCT DATA 1
GETREAD - ACCT DATA 2
GETREAD - CAPT PORTAL
GETREAD - GUEST REGISTRATION
GETREAD - USERS BY LOGON SUCCESS
GETREAD - USERS BY LOGON FAIL
GETREAD - CLIENTS PER AP
GETREAD - REJECT REASONS
GETREAD - USER USAGE SUM
GETREAD - USAGE BY TERMS
GETREAD - USAGE TOTALS AND AVERAGES
GETREAD - USAGE PER IP
GETREAD - USAGE PER NAS
GETDOWNLOAD CSV FORMAT
PATCHCHANGE FULL NAME

CHANGE FULL NAME

Authorization:

Authorization token in format "Bearer API_KEY"

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
authorizationHEADER
REQUIREDAPI token
content-typeSTRING
REQUIREDcontent-type
acceptSTRING
REQUIREDaccept
Required Parameters
fullnameSTRING
REQUIREDfullname
account_idSTRING
REQUIRED
Code Snippet
unirest.patch("https://ironwifi.p.rapidapi.com/api/account/{account_id}")
.header("X-RapidAPI-Host", "ironwifi.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.header("content-type", "application/json;charset=UTF-8")
.header("accept", "application/json, text/plain, */*")
.send("fullname=firstname lastname")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
Sample Response
General
Request URL: https://ironwifi.p.rapidapi.com/api/account/{account_id}
Request Method: PATCH
Response Headers
Response Body

Install SDK for NodeJS

Installing

To utilize unirest for node.js install the the npm module:

$ npm install unirest

After installing the npm package you can now start simplifying requests like so:

var unirest = require('unirest');

Creating Request

unirest.patch("https://ironwifi.p.rapidapi.com/api/account/{account_id}")
.header("X-RapidAPI-Host", "ironwifi.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.header("content-type", "application/json;charset=UTF-8")
.header("accept", "application/json, text/plain, */*")
.send("fullname=firstname lastname")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication