Ojmar Nexo NLX1, Instruction Manual, Page: 87 / 188

7_API REFERENCE MANUAL
OJMAR 87
7. API REFERENCE MANUAL
7.1 INTRODUCTION
The following document describes the web services that the third-party software
may use to communicate with Ojmar API.
API is divided in 3 different modules, as can be seen in figure below:
1.
Datamodel API
: Permits the interpretation of the information obtained from the
locks and cards independently of the version of lock that operates in the facility.
This part of the API works as a parser, so it is able to encrypt/decrypt the
information of the card/lock.
2.
Recorders’ API
: The API implements the communication with both
peripherals, including functions to write and read cards and all the NFC
programmer functions.
3.
Socket API
: The API implements a mechanism based on sockets to receive
information from the locks and to send answers back to them.
Figure 7-1. Figure 1 API Overview.
Document will be divided in these 3 modules.
API will be composed by JSON structures, and 3rd party SW will use the web
services in order to communicate with the API.
In most of these web services it is necessary to specify the type of the lock
(lock_type) against which the card or the NFC programmer will act. There are
different types of locks and they are classified in two groups, locks that can work in
the online system and locks that can't work in the online system. Nowadays, there
are two Ojmar locks, one for each type working system.