The authentication model used by Linkar REST API is based on the generation of API Keys. The Linkar administrator generates an API Key with the necessary parameters for authentication. This way no login credentials are shared. This API Key must be attached in the header of the HTTP call so that Linkar can recognize its validity and execute the operation.
You can create API Keys for each group of endpoints from the top menu. Due to the monitoring and control nature of the API Manager, its API Keys are different from those of the API SendCommand.
The top button opens swagger for Linkar Rest API. Swagger is an Interface Description Language for describing RESTful APIs expressed using JSON and XML. Swagger is used together with a set of open-source software tools to design, build, document, and use RESTful web services. Swagger includes automated documentation, code generation (into many programming languages), and test-case generation.
Manager API Key
You can create as many API Keys as you need and limit them for a period of time or run them from predefined IPs.
API Key
|
string, Mandatory
|
|
It is an automatic random GUID value. It is the value needed to access through the Linkar REST API
|
Description
|
string, Mandatory
|
|
API Key description.
|
Deactivate
|
|
|
Disable the use of the API Key.
|
Activate log
|
|
|
Linkar SERVER will generate a record with API Key activity.
|
User
|
Mandatory
|
|
The Linkar user for the requests.
|
Expiration Date
|
datetime
|
|
API Key expiration date. Once this date is over, the API Key will be disabled.
|
Allowed IPs
|
IP, Mandatory
|
|
IPs the API Key will allow for use. Any request received from an IP that is not on this list will be rejected.
|
|
SendCommand API Key
Each API Key is linked to an EntryPoint, a user and one or more IP addresses from which HTTP calls can be made. You can also limit the life of the API Key to a stipulated date and time, and you can limit the use of certain Linkar functions to call.
API Key
|
string, Mandatory
|
|
It is an automatic random GUID value. It is the value needed to access through the Linkar REST API
|
Description
|
string, Mandatory
|
|
API Key description.
|
Deactivate
|
|
|
Disable the use of the API Key.
|
Activate log
|
|
|
Linkar SERVER will generate a record with API Key activity.
|
EntryPoint
|
Mandatory
|
|
EntryPoint associated with the API Key.
|
User
|
Mandatory
|
|
The Linkar user for the requests.
|
Plugin Ref
|
string
|
|
Plugin identifier. In case this API Key is going to be used by a plugin, let's send your Plugin Ref in Linkar. See the Linkar Plugins Manager section.
|
Expiration Date
|
datetime
|
|
API Key expiration date. Once this date is over, the API Key will be disabled.
|
Allowed IPs
|
IP, Mandatory
|
|
IPs the API Key will allow for use. Any request received from an IP that is not on this list will be rejected.
|
Allowed Operations
|
Mandatory
|
|
Client Functions that the API Key can execute. Client Functions not included in this list will be rejected.
The possible functions are all available except Login and Logout functions since all operations are direct. When executing an inquire, Linkar establishes a direct temporary session and deletes it at the end. These sessions have the word VOLATILE as Id.
|
|
