We advise you to use the Linkar Web Services. You can easily migrate your Linkar REST API configuration to Linkar Web Services using the sendcommand Group. The only thing you have to do is to change the IP:Port of the call. Ask us if you have any questions.
Linkar REST API is used by applications to exchange data over HTTP(S) as JSON or XML objects.
All operations supported by SendCommand Templates are also supported with the API SendCommand, including full CRUD operations (Create, Read, Update, Delete).
The API Manager group of endpoints performs Linkar Server monitoring and management operations. They allow to check the current status of the server as well as to stop or start EntryPoints among other things.
A sophisticated authentication and authorization model limits API access and usage:
•An API Key is generated for each client.
•The key permits access to a single EntryPoint.
•Inbound access to specific IP addresses or ranges.
•Each key is authorized and limited to perform specific functions.
•Each key is assigned to a Linkar user, which may be created for any specific or broad-use purpose.
Access can also be denied after issue:
•Keys can be assigned an expiration date/time.
•They can be manually deactivated.
•The Linkar user associated with the key can be deactivated or deleted.
All such details are configured in Linkar Manager. See the next page for details.
With this mechanism, DBMS login credentials are not shared "on the wire". The API Key and Linkar user ID must be included in the header of each HTTP call so that Linkar can recognize its validity and execute the requested operation.
All REST API requests go through Linkar MANAGER, not Linkar SERVER. Therefore the Linkar MANAGER service must be started and accessible to clients in order to use the Linkar REST API. For added security and logging benefits, Linkar REST API requests can also be processed through Internet Information Server (IIS) or Apache.
