POST https://www.wiru.co.za/api/AUTH

Used to authenticate API user and obtain a token on successfull login

https://www.wiru.co.za/api/AUTH

form-data

username	Provided username	required
password	Provided password	required
apikey	Provided apikey	required

Successful call JSON data returned

{ "username": "your username", "session_start": "Api session timer start", "session_stop": "Api session timer stop", "api_call_limit": "Your Api call limit", "current_api_call_count": "Your current api count", "token": "Token for current session" }

Unsuccessful call

INVALID USERNAME/PASSWORD/APIKEY COMBINATION JSON data returned: { "message": "Invalid username,password or api_key combination" }

INVALID METHOD JSON data returned: { "message": "Invalid method" }

POST https://www.wiru.co.za/api/NEWCHECK

WIRUlink new coverage check

form-data

token	Token received from AUTH method	required
GPSX	Location GPSX(Latitude)	required
GPSY	Location GPSY(Longitude)	required
Detailed	Option "yes" or "no".	default is "no"

token accepted variables

Token received from AUTH method - REQUIRED to do a coverage check

Token has a session timer, if session time expires new AUTH method must be called to get new token.

Detailed : if set to yes, returns detailed coverage check results.

Successful call JSON data returned

Note: Only results for services, networks you have access too would be returned. {  "reference": "745eb2fc",  "networks": {   {    "non_rush": "OK"   },   {    "rush": "OK"   },   {    "vuma": "OK"   },   {    "dfa": "OK"   },   {    "evotel": "OK"   },   {    "sadv": "OK"   }  } } reference return unique coverage check reference. service array return of successful coverage services. networks array return of all network results as per request.

Unsuccessful call

INVALID TOKEN SPECIFIED JSON data returned: { "message": "ERROR: Invalid Token" }

INVALID GPSX SPECIFIED JSON data returned: { "message": "GPSX can not be blank" }

INVALID GPSY SPECIFIED JSON data returned: { "message": "GPSY can not be blank" }

INVALID METHOD JSON data returned: { "message": "Invalid method" }

POST https://www.wiru.co.za/api/NEWCHECK

WIRUlink new coverage check

form-data

token	Token received from AUTH method	required
GPSX	Location GPSX(Latitude)	required
GPSY	Location GPSY(Longitude)	required
service	Services to check	if not specified, defaults to "all"
network	Networks to check	if not specified, defaults to "all"
agl	Network selection	if not specified, defaults to 5m above ground level
maxagi	Max Height limit on customer side	if not specified, defaults to 12m max height above ground level

token accepted variables

Token received from AUTH method - REQUIRED to do a coverage check

Token has a session timer, if session time expires new AUTH method must be called to get new token.

service accepted variables

not specified	Defaults to all services - wireless, fibre_home, fibre_business
all	Check all services - wireless, fibre_home, fibre_business
wireless	Check all wireless services - rush, non_rush
fibre_home	Check all home fibre services - Vuma, Evotel, SADV
fibre_business	Check all business fibre services - DFA

network accepted variables

not specified	Defaults to all networks - Rush, Non_rush, Vuma, Evotel, SADV, DFA
all	All networks - Rush, Non_rush, Vuma, Evotel, SADV, DFA
Should you require coverage check on specific network just enter one of the following network names here. rush, non_rush, vuma, evotel, sadv, dfa

Successful call JSON data returned

{  "reference": "745eb2fc",  "service": [   "wireless",   "fibre_home",   "fibre_business"  ],  "networks": [   {    "non_rush": "OK"   },   {    "rush": "OK"   },   {    "vuma": "OK"   },   {    "dfa": "OK"   },   {    "evotel": "OK"   },   {    "sadv": "OK"   }  ] } reference return unique coverage check reference. service array return of successful coverage services. networks array return of all network results as per request.

Unsuccessful call

INVALID TOKEN SPECIFIED JSON data returned: { "message": "ERROR: Invalid Token" }

INVALID GPSX SPECIFIED JSON data returned: { "message": "GPSX can not be blank" }

INVALID GPSY SPECIFIED JSON data returned: { "message": "GPSY can not be blank" }

INVALID SERVICE SPECIFIED JSON data returned: { "message": "ERROR: no valid service specified" }

INVALID NETWORK SPECIFIED JSON data returned: { "message": "ERROR: no valid network specified" }

INVALID METHOD JSON data returned: { "message": "Invalid method" }

POST https://www.wiru.co.za/api/RECHECK

WIRUlink recheck existing coverage

form-data

token	Token received from AUTH method	required
reference	Existing coverage reference	required
service	Services to check	if not specified, defaults to "all"
network	Networks to check	if not specified, defaults to "all"
agl	Network selection	if not specified, defaults to 5m above ground level
maxagi	Max Height limit on customer side	if not specified, defaults to 12m max height above ground level

token accepted variables

Token received from AUTH method - REQUIRED to do a coverage check

Token has a session timer, if session time expires new AUTH method must be called to get new token.

reference accepted variables

reference	Existing valid coverage reference number	Required

service accepted variables

not specified	Defaults to all services - wireless, fibre_home, fibre_business
all	Check all services - wireless, fibre_home, fibre_business
wireless	Check all wireless services - rush, non_rush
fibre_home	Check all home fibre services - Vuma, Evotel, SADV
fibre_business	Check all business fibre services - DFA

network accepted variables

not specified	Defaults to all networks - Rush, Non_rush, Vuma, Evotel, SADV, DFA
all	All networks - Rush, Non_rush, Vuma, Evotel, SADV, DFA
Should you require coverage check on specific network just enter one of the following network names here. rush, non_rush, vuma, evotel, sadv, dfa

Successful call JSON data returned

{  "reference": "745eb2fc",  "service": [   "wireless",   "fibre_home",   "fibre_business"  ],  "networks": [   {    "non_rush": "OK"   },   {    "rush": "OK"   },   {    "vuma": "OK"   },   {    "dfa": "OK"   },   {    "evotel": "OK"   },   {    "sadv": "OK"   }  ] } reference return unique coverage check reference. service array return of successful coverage services. networks array return of all network results as per request.

Unsuccessful call

INVALID TOKEN SPECIFIED JSON data returned: { "message": "ERROR: Invalid Token" }

INVALID REFERENCE JSON data returned: { "message": "Invalid reference" }

INVALID SERVICE SPECIFIED JSON data returned: { "message": "ERROR: no valid service specified" }

INVALID NETWORK SPECIFIED JSON data returned: { "message": "ERROR: no valid network specified" }

INVALID METHOD JSON data returned: { "message": "Invalid method" }