GuardPoint10 API Guide

Introduction 

RESTful API uses HTTP requests to GET, PUT, POST and DELETE data. 

This document is intended for developers.

1. Enabling the GuardPoint 10 API

GuardPoint 10 by default does not provide developer access to its underlying engine. To use GuardPoint 10's HTTP API you must enable this functionality using a license code.

To check whether you have the license go to the menu Help/License:

Check that the API say ‘yes’ if this says NO contact support@sensoraccess.co.uk who will issue you a serial code to enable this.

Go management/users to create a user and password and toggle the allow API = yes and specify a API Key:

2. GuardPoint 10 API Overview 

The API was generated to follow the OData Version 4.0 standard to be quickly consumed by OData clients.

However you may wish to manually construct the API HTTP Requests yourself.

A Postman Collection is available which provides a complete list of Endpoints and examples on how to use them.

See: https://drive.google.com/drive/folders/1sTUsVG4T90NPqVmQylEXPQ1kO7JDkGn1 

Please contact support@sensoraccess.co.uk for further help on setting up the postman environment.

3 Push events (SignalR) 

Events from GuardPoint10 will be pushed to API clients through SignalR, which is an open source technology (lead by Microsoft) and has clients in all major platforms and technology.

More information about SignalR can be found here. 

4. Demo Server

An API server is online and available for demonstration and to start the beginning of  your development

The link below will show the available server with it various API endpoints:

http://sensoraccess.duckdns.org:10695/odata

For token authentication you can use the user name = admin and password = admin

For API-Key authentication use 00000000-0000-0000-0000-000000000000 

14. Python Module

Also the following Python module:  https://pypi.org/project/pyGuardPoint/ - if they want to do something quickly programmatically.