BorderlessHub M2M web services API

Overview

This is BorderlessHub M2M web services. It provides user simple APIs to interact with the SIM. It is accessible by user that subscribed to BorderlessHub SIM package.

Postman Client

We used Postman to test the API. You can download Postman here.

Overview of APIs

Special Message

This SendSMS would be deprecated after end Feb 2018.
Kindly make the necessary changes to your web services client to use the new API /UpdateSim/SendSms/{iccid}.

API	URL	Method	Description
SendSMS (deprecated)	/SendSMS	POST	Send SMS via providing the valid user ID, password and iccid in the message boda. The SIM status needs to be "productive". User can specify the optional sender, validity of day, hour and minute of the message.

New list of APIs

API	URL	Method	Description
Get Sims	/Info/GetSims	GET	Get the list of all Sims.
Get Sims V2	/Info/GetSimsV2	GET	Get the list of all Sims including custom fields
Get Offers	/Info/GetOffers	GET	Get the list of all offers applicaable to the user.
Get a Sim Offer	/Info/GetOffer/{iccid}	GET	Get the offer current assigned to a sim.
Terminate a Sim	/UpdateSim/Terminate/{iccid}	PUT	Terminate a sim and returns it back to "OnStock". A sim must be in either "Productive" or "Suspended" status before it can be terminated.
Activate a Sim	/UpdateSim/Activate/{iccid}	PUT	Activate a sim. A sim must be in "OnStock" status before it can be activated. During activation, user need to provide the offer to be assigned to the sim.
Modify a Sim	/UpdateSim/Modify/{iccid}	PUT	Modifying a sim typically changed the sim offer. A sim must be in "Productive" status before it can be modified.
Suspend a Sim	/UpdateSim/Suspend/{iccid}	PUT	Suspend a sim. A sim must be in "Productive" status before it can be suspended.
Resume a Sim	/UpdateSim/Resume/{iccid}	PUT	Resume a sim. A sim must be in "Suspended" status before it can be resumed.
Update a Sim Location	/UpdateSim/Location/{iccid}	PUT	Force a sim to re-attach to the network.
Send an SMS to a Sim	/UpdateSim/SendSms/{iccid}	POST	Sending an SMS to a sim. the API call must provide a message.