5222
Beginning in Access It! Universal.NET 6.2 support has been added for a RESTful Web API. The API requires an existing user within Access It! Universal.NET's username and password be passed using basic authentication. The API respects the permissions for the user account such that if one were to try to unlock a door they are not authorized, the API call would return unauthorized. The API contains complete documentation outlining the API endpoints, commands, and data models.
The use of the API is strictly designed for those with software development experience and is provided as-is. Assistance developing solutions using the API fall outside the scope of support provided by the RS2 Technologies technical support group.
- Access It! Universal.NET min s/w v6.2
Access It! Universal.NET V7 required manual entry of an API Database key within the server properties screen. This key would be provided by RS2 Technologies customer service. Access It! Universal.NET V8 no longer requires manual entry as the API keys are embedded within the license file. Systems can confirm they are licensed by looking at the API Options section of the System Status screen.
Beginning with Access It! Universal.NET 7.0 all communication to the API must be done through HTTPS. This will require a SSL certificate to be purchased and then bound to the port used by the API. See KB Article 701 for more information.
A self signed certificate is not recommended for production systems.
Access It! Universal.NET V7 configuration
- Within Access It! Universal.NET navigate to the System | Servers section
- Edit the Access It! Universal.NET server
- Select the services tab
- Configure the port for the API service as needed
This is the port the API will be using for API requests. - Select (check) the HTTPS checkbox if wanting to secure the web traffic
HTTPS requires a SSL certificate bound to the port. See KB Article 701 for more information. Version 7 systems must use HTTTPS - Click Save
- Restart the Access It! Universal.NET services
Opening API Swagger documentation
- On the server machine, navigate to https://localhost:APIPORT/swagger
If using HTTPS use https://localhost:APIPort/swagger.
Replace APIPort as needed.
RS2 REST API User’s Guide
Swagger User Interface
