Access It! Universal.NET API


Overview

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.

Software Requirements

  • Access It! Universal.NET min s/w v6.2

HTTPS Requirement

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 configuration

  1. Within Access It! Universal.NET navigate to the System | Servers section
  2. Edit the Access It! Universal.NET server
  3. Select the services tab
  4. Configure the port for the API service as needed
    This is the port the API will be using for API requests.
  5. 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
  6. Click Save
  7. Restart the Access It! Universal.NET services

Opening API Swagger documentation

  1. On the server machine, navigate to https://localhost:APIPORT/swagger
    If using HTTPS use https://localhost:APIPort/swagger.
    Replace APIPort as needed.

Additional API documentation

https://rs2tech.com/RS2WebApp/PDF/RS2_REST_API_v1_Users_Guide.pdf
https://rs2tech.com:7777/swagger/ui/index


  • 704
  • 30-Jul-2019
  • 1938 Views