The Skyresponse Administrative API
Why an Administrative API?
Skyresponse Response forwards event details from digital, internet connected devices and systems to respondents in response centers using a decentralized, cloud based IT platform. With the Skyresponse Administrative API your computerized system may define objects, alarm receptions and many other objects in Skyresponse Response simply by using standardized and well documented API calls.
The API is invoked by REST calls to a set of endpoints, using methods and associated parameters that enable an external system to set and edit all the features of Skyresponse Response available to an administrator logged in to the Skyresponse Administrative Graphical User Interface (GUI).
Entities in Skyresponse Response which can be Edited via the API
To use the administrative API it is important to understand the relations between some of the basic entities of Skyresponse Response and the terminology employed. Although many types of objects may generate alarms and other events to be handled by Skyresponse Response, the following terms in italics are the ones primarily used in the API context: Alarms are generated by objects or users, having transmitters, the alarms are treated per the rules of an alarm handling and sent to a response center where respondents in a recipient group handles the alarms. Technically respondents are referred to as admins.
The object is the lowest and most basic element in the hierarchy of administrative logical entities. The full hierarchy consists of Object, Sub-customer, Customer and Seller where the Seller in turn is subordinate to the entire Skyresponse Response entity.
Actions performed via the administrative API encompass the creation, editing and removal of objects, sub-customers and customers in the above hierarchy, as well as the coupling of objects to alarm handlings and thereby also to response centers and their recipient groups. The administrative GUI and the administrative API are complementary ways of administering Skyresponse Response, all functions of the GUI are actually performed by API calls.
Note that some of the features that can be controlled via the API are related to the permissions assigned to your access token (seller, customer etc. with subcategories). Please contact Skyresponse support if any Forbidden responses occur.
The Skyresponse Administrative API
Why an Administrative API?
Skyresponse Response forwards event details from digital, internet connected devices and systems to respondents in response centers using a decentralized, cloud based IT platform. With the Skyresponse Administrative API your computerized system may define objects, alarm receptions and many other objects in Skyresponse Response simply by using standardized and well documented API calls.
The API is invoked by REST calls to a set of endpoints, using methods and associated parameters that enable an external system to set and edit all the features of Skyresponse Response available to an administrator logged in to the Skyresponse Administrative Graphical User Interface (GUI).
Entities in Skyresponse Response which can be Edited via the API
To use the administrative API it is important to understand the relations between some of the basic entities of Skyresponse Response and the terminology employed. Although many types of objects may generate alarms and other events to be handled by Skyresponse Response, the following terms in italics are the ones primarily used in the API context: Alarms are generated by objects or users, having transmitters, the alarms are treated per the rules of an alarm handling and sent to a response center where respondents in a recipient group handles the alarms. Technically respondents are referred to as admins.
The object is the lowest and most basic element in the hierarchy of administrative logical entities. The full hierarchy consists of Object, Sub-customer, Customer and Seller where the Seller in turn is subordinate to the entire Skyresponse Response entity.
Actions performed via the administrative API encompass the creation, editing and removal of objects, sub-customers and customers in the above hierarchy, as well as the coupling of objects to alarm handlings and thereby also to response centers and their recipient groups. The administrative GUI and the administrative API are complementary ways of administering Skyresponse Response, all functions of the GUI are actually performed by API calls.
Note that some of the features that can be controlled via the API are related to the permissions assigned to your access token (seller, customer etc. with subcategories). Please contact Skyresponse support if any Forbidden responses occur.