Previous topicNext topic
 Link Technologies - LinkSOFT Documentation 
Help > Link Web Applications Portal > Integration > Integration Setup > Web API >
LinkSOFT API
Overview

LinkSOFT API is used to transfer data from one LinkSOFT database to another. It uses REST API methodology to transfer data.

This API is designed for the following modules:

  1. Replication
  2. Time & Attendance

This API has been designed to easily accommodate integration to other systems.

Steps to configure integration to LinkSOFT API:

  1. General Settings

    Flag

    Description

    Value

    Base URL

    Base URL for LinkSOFT API. Enter the website URL where to send the data. E.g: http://www.example.com/LinkSOFT

    http://www.example.com/LinkSOFT
    Authorization API Key. Get this value from "Global Administration -> Security Token". It is recommended to use one security token for each client. Security Token ID
    Username Username used to access data. Get this value from "Global Administration -> User Maintenance" admin
    Start Time API Access Start Time. This is the time when the system will start accessing the API. 6:00 AM 
    End Time API Access End Time. This is the time when the system will stop accessing the API. 8:00 PM
    Delay Between API Calls Delay Between API Calls. This is used to handle throttle limits imposed by the API. 0 milliseconds
    API Start Date API Start Date used to set the initial start date. It is also used to stop the API for a period of time. Start Date
    API Request Timeout API Response Timeout in Milliseconds 600000 milliseconds (10 minutes)
    API Payload Size API Payload Size in Kilobytes. Used to limit the size of each package. 25000 KB (25 MB)

  2. Request Header POST - Configurations used by the API when transmitting data

    Flag

    Description

    Value

    Authorization

    Authorization Bearer {GeneralSetting.Authorization}
    Content-Type Content-Type application/json
  3. Replication - Enable data transmission for Point of Sale Replication

    Flag

    Description

    Value

    CompareData.URL.POST

    URL to send data for comparison

    /api/LinkAPI
    Receive.URL.POST URL to receive data /api/LinkAPI
    ReceiveAcknowledge.URL.POST URL to acknowledge received data /api/LinkAPI
    Send.URL.POST URL to send data /api/LinkAPI
    BatchSize Number of records in each transmission batch 5000
    APIWaitTime Wait time for complex API operations to complete 10 minutes

  4. Time and Attendance - Enable data transmission for Time & Attendance

    Flag

    Description

    Value

    Send.URL.POST

    URL to send Time & Attendance data /api/LinkAPI