ISP BILLING API

Umeskia Softwares ISP Billing API is a RESTful API that allows you to integrate your ISP billing system with Umeskia Softwares ISP Billing System. The API allows you to get hotspot plans, register vouchers and get vouchers.

GET HOTSPOT PLANS
Method Endpoint
POST https://api.umeskiasoftwares.com/api/v1/isp/hostspotplans
Headers:
Header Description value
Content-Type The Accept request HTTP header advertises which content types, expressed as MIME types, the client can understand. application/json 

                                  "Content-Type : application/json"
Parameters:
Parameter Description Sample value
api_key API key obtained from your Umeskia Softwares Portal (USP) VE5MTlkzRk06MTlwNjlkZWM=
email Email that you use to login into Umeskia Software Portal (USP) example@gmail.com
station_id Station id from ISP UMS PORTAL UMS26595527 

                                    {
                                        "api_key":"VE5MTlkzRk06MTlwNjlkZWM=",
                                        "email":"example@gmail.com",
                                        "station_id" : "UMS26595527"
                                      }
Response:

                           {
                                        "ResultCode": "200",
                                        "message": "Request sent successfully. UMS26595527",
                                        "ComapanyName": "UMESKIA SOFTWARES",
                                        "CompanyInfo": {
                                            "Address": "Nairobi, Kenya",
                                            "Contact": {
                                                "Email": "info@umeskiasoftwares.com",
                                                "Phone": "0113015674"
                                            },
                                            "Logo": "https://portal.umeskiasoftwares.com/companylogo/1708984865laraAdminfy_logo.png",
                                            "Description": "SOLVING PROBLEMS WITH THE POWER OF TECHNOLOGY.",
                                            "Website": "www.umeskiasoftwares.com",
                                            "primaryColor": "#420505",
                                            "secondaryColor": "#0c2b03"
                                        },
                                        "stationData": {
                                            "stationName": "TANDAO HOTSPOT - KANGU",
                                            "stationLocation": "Kutus, Kenya",
                                            "stationPool": "TANDAO-KANGU-POOL",
                                            "remoteIp": "192.168.74.1",
                                            "nasPassword": "273641958",
                                            "localIp": "192.146.98.1",
                                            "domainName": "ums.net",
                                            "stationId": "UMS26595527",
                                            "customerCare": "0113015674",
                                            "stationPackages": [
                                                {
                                                    "planCode": "U77434129",
                                                    "price": "10",
                                                    "numericExpiration": "5",
                                                    "stringExpiration": " Mbps",
                                                    "planType": "speed",
                                                    "connectionType": "Speed plan",
                                                    "validityPeriod": "1 Hour",
                                                    "allowedDevices": "1"
                                                },
                                                {
                                                    "planCode": "U69568596",
                                                    "price": "10",
                                                    "numericExpiration": "30",
                                                    "stringExpiration": " Minutes",
                                                    "planType": "time",
                                                    "connectionType": "Time plan",
                                                    "validityPeriod": "30 Minutes",
                                                    "allowedDevices": "2"
                                                },
                                                {
                                                    "planCode": "U46169734",
                                                    "price": "10",
                                                    "numericExpiration": "10",
                                                    "stringExpiration": " MB",
                                                    "planType": "data",
                                                    "connectionType": "Data plan",
                                                    "validityPeriod": "1 Hour",
                                                    "allowedDevices": "1"
                                                },
                                                {
                                                    "planCode": "U54849986",
                                                    "price": "20",
                                                    "numericExpiration": "15",
                                                    "stringExpiration": " Hours",
                                                    "planType": "time",
                                                    "connectionType": "Time plan",
                                                    "validityPeriod": "15 Hours",
                                                    "allowedDevices": "2"
                                                },
                                                {
                                                    "planCode": "U92191578",
                                                    "price": "35",
                                                    "numericExpiration": "24",
                                                    "stringExpiration": " Hours",
                                                    "planType": "time",
                                                    "connectionType": "Time plan",
                                                    "validityPeriod": "24 Hours",
                                                    "allowedDevices": "2"
                                                },
                                                {
                                                    "planCode": "U42514542",
                                                    "price": "200",
                                                    "numericExpiration": "1",
                                                    "stringExpiration": " Week",
                                                    "planType": "time",
                                                    "connectionType": "Time plan",
                                                    "validityPeriod": "1 Week",
                                                    "allowedDevices": "2"
                                                }
                                            ]
                                        }
                         }
                                '
REGISTER VOUCHER
Method Endpoint
POST https://api.umeskiasoftwares.com/api/v1/isp/registervoucher
Headers:
Header Description value
Content-Type The Accept request HTTP header advertises which content types, expressed as MIME types, the client can understand. application/json 

                                  "Content-Type : application/json"
Parameters:
Parameter Description Sample value
api_key API key obtained from your Umeskia Softwares Portal (USP) VE5MTlkzRk06MTlwNjlkZWM=
email Email that you use to login into Umeskia Software Portal (USP)
plan_code Plan code from ISP UMS PORTAL U77434129
voucher_code Voucher code from ISP UMS PORTAL GHOT 

                                     {
                                        "api_key":"VE5MTlkzRk06MTlwNjlkZWM=",
                                        "email":"example@gmail.com",
                                        "plan_code" : "U77434129",
                                        "voucher_code" : "GHOT"
                                      }
Response:

                                    {
                                          "ResultCode": "200",
                                          "message": "Voucher registered successfully",
                                          "registeredVoucher": "GHOT",
                                          "stationId": "UMS26595527",
                                          "stationName": "TANDAO HOTSPOT",
                                          "stationLocation": "Chonjo Village, Mwembe Tayari, Mombasa, Kenya",
                                          "planCode": "U77434129",
                                          "planName": "1 HOUR ",
                                          "planPrice": 10
                                      }