TestWebhook
API | Description |
---|---|
POST api/TestWebhook?APIKey={APIKey}&ControllerID={ControllerID}&ControllerPassword={ControllerPassword}&ControllerDataID={ControllerDataID} |
This will send a test Webhook to the registered webhook address for the controller. You must pass the ControllerDataID you would like to send. |
Authorize
API | Description |
---|---|
GET api/Authorize?APIKey={APIKey}&MACaddress={MACaddress} |
Returns the ControllerID and Password for an Existing Registered Controller. |
Suspend
API | Description |
---|---|
GET api/Suspend?APIKey={APIKey}&ControllerID={ControllerID} |
This will suspend the Webhook posting of data for this controller. |
UpdateRegistration
API | Description |
---|---|
GET api/UpdateRegistration?APIKey={APIKey}&ControllerID={ControllerID}&ControllerPassword={ControllerPassword}&ModelNumber={ModelNumber}&LocationTimeZone={LocationTimeZone}&ControllerName={ControllerName}&LocationName={LocationName} |
This will validate the information sent and then update the controllers model #, Name and Timezone |
SwapMACAddress
API | Description |
---|---|
GET api/SwapMACAddress?APIKey={APIKey}&ControllerID={ControllerID}&OldMACaddress={OldMACaddress}&NewMACaddress={NewMACaddress} |
This will Remove the existing MAC Address from the controller and replace it with the provided MAC Address. This is to be used in cases where the controller is broken and being replaced and you want to retain all data. |
Enable
API | Description |
---|---|
GET api/Enable?APIKey={APIKey}&ControllerID={ControllerID} |
Enables the webhook posting for a previously Suspended controller |
Register
API | Description |
---|---|
GET api/Register?APIKey={APIKey}&MACaddress={MACaddress}&ModelNumber={ModelNumber}&OwnerEmail={OwnerEmail}&LocationName={LocationName}&LocationTimeZone={LocationTimeZone}&ControllerName={ControllerName} |
This will return the ControllerID and Password for a controller that has never been registered on the IPS Website. The system will try to find an existing account with the Email provided. If not found, a new account is created. If found the controller is added to the account. The system will then try to match the Location Name and add the controller to the location. This will enable the controller on the IPS monitoring website and allow the owner to login directly to our website. If you do not want this to happen, you need to specify an email for your company to act as the owner. |
WebHookStatus
API | Description |
---|---|
GET api/WebHookStatus?APIKey={APIKey}&ControllerID={ControllerID} |
This will return the current webhook status of the controller |
Update
API | Description |
---|---|
PUT api/Update?APIKey={APIKey}&ControllerID={ControllerID}&ControllerName={ControllerName} |
This will Update the Controller Name Only |
ResetData
API | Description |
---|---|
GET api/ResetData?APIKey={APIKey}&ControllerID={ControllerID}&StartDate={StartDate}&EndDate={EndDate} |
Removes the API Data Reference Keys for the time period specified |
Terminate
API | Description |
---|---|
GET api/Terminate?APIKey={APIKey}&ControllerID={ControllerID} |
This will remove the controller from the API account and reset the Controller Password |
TestAlert
API | Description |
---|---|
POST api/TestAlert?APIKey={APIKey}&ControllerID={ControllerID}&ControllerPassword={ControllerPassword}&ControllerAlertID={ControllerAlertID} |
This will send a test Webhook to the registered Alert webhook address for the controller. You must pass the ControllerDataID you would like to send. |
RemoveController
API | Description |
---|---|
GET api/RemoveController?APIKey={APIKey}&MACaddress={MACaddress}&ControllerID={ControllerID}&ControllerPassword={ControllerPassword} |
This is a very dangerous API call as it will completely delete all data and remove the controller from our system and allow the controller to be registered again. |