API4Client Help Page

Introduction

Here you will find description of PiSuite WebApi that can be used by clients to manipulate Subscribers and Alerts in PiSuite.

The API is available at https://api4c.pisuite.com/

Each call to an API method needs to include two HTTP headers apikey and siteid. A client can obtain their values from the PiSuite admin application at https://app.pisuite.com/Client/WebSite/Edit.aspx, as illustrated in the following screenshot.

Alert

Provide methods to Create, Update and Delete an alert.

API	Description
POST Alert/Add	Create a new alert
POST Alert/Update	Update an alert
POST Alert/Delete	Delete an alert in PISuite. If there are no reads for the alert, then delete the alert. Otherwise mark the alert as inactive.

Subscriber

Provide methods to maintain subscribers in PiSuite

API	Description
POST Subscriber/BulkUpdate	Update a list of subscribers in PiSuite. If the required action on a subsciber is deletion, then the subscriber will be deleted only if there are no referenced records (alerts, favourites) for the subscriber. Otherwise mark the subscriber as inactive.