Gatekeeper Api

Open Api Documentation

For more information on available calls and messages structure goto the open api docs

Overview

The pupose of Gatekeeper is to record movements with a purpose in and out of facilities via predefined Gates, and to provide additional instructions to drivers entering the facility for a specific purpose. The Gatekeeper module was developed to function as a standalone module or to integrate with other modules like Link-Facilities where bookings are scheduled.

Facility

Defines the location/area of the organisation being visited.

Gate

Point of entry or exit out of the facility. A gate can be setup to allow Movements of eith type: Entry, Exit or both.

Visit

A visit groups Movements together at the facility along with a Purpose, recorded Checkpoints and other auditing information.

Visit Types

Visit Statusses

Checkpoint

Each entry/exit is recorded as a checkpoint on the Visit where various device scans and/or fields of information are captured. Once the final checkpoint is captured, the Visit is Completed.

(Checkpoint) Configuration

Checkpoint configurations can be configured for combinations of Facility / MovementType / VisitType / VisitSubType which includes Fields to be captured/scanned.

Checkpoint Fields

These are the fields that need to be recorded at Checkpoints. Fields can be marked as optional and validation can be enabled to perform validation checks on the values recorded.

Checkpoint Field Types

Operator

Operators are created the same way as in other modules, granting access to the Gatekeeper mobile application.

Device

A mobile device that is registered against one or more gates. See api here.