You are using an unsupported browser. Please update your browser to the latest version on or before July 31, 2020.
close
Home > Access It! Universal.NET > How To... > Access It! Universal.NET API
Access It! Universal.NET API
print icon

Overview

Beginning in Access It! 6.2 support has been added for a RESTful Web API. The API requires an existing Access It! username and password be passed using basic authentication, or a bearer token to utilize SSO sign in. 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 Access It! support group.

Software Requirements

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

API Keys

Legacy versions of Access It! required manual entry of an API Database key within the server properties screen. Access It! V8 and higher 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.

HTTPS Requirement

All communication to the API must be done through HTTPS. This will require a SSL certificate to be created/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! Configuration

  1. Within Access It!, navigate to the System | Servers section
  2. Edit the Access It!, 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. Click Save
  6. Restart the Access It! Universal.NET services

Opening API Swagger documentation

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

Single Sign On

Beginning with Access It! Universal.NET 9.0, support to pass a Bearer Token within the API authorization header has been added. To configure, a SSO Provider must already exists and then can be selected when configuring the API port under System | Servers. More on creating SSO providers can be found in the SSO Provider KB Article.
Additional API documentation

RS2 REST API User’s Guide
Swagger User Interface


scroll to top icon