The Agent is the local app we built to connect to your end user's on-premise company file. It is private label branded to your app so that your users don't get confused by seeing a third party application.

Install the Agent

Your user will need to download the desktop agent, and follow the install process. Your Agent will be branded with your logos (see the Branding section) and company name. This should be installed on any machine that has either local or network access to the company file you want to connect to.

Enter the Agent Token

The end user enters the token you sent them after you called /managet/user, and clicks Login.

Test Ping the Agent

To see if the Agent is connected to the API, make this request.

https://api.getautofy.com/v2/Manage/IsActive/{agentToken}

Example:

curl --request GET \
  --url https://api.getautofy.com/v2/Manage/IsActive/BI45538M6MSQG75TG6E76V63GQ3H \
  --header 'cache-control: no-cache'
  --header 'x-api-key: {YOUR_API_KEY}' \

Response:

{
    "Self": null,
    "Kind": "collection",
    "RequestId": "32837614F61F4B2DAB9B796F7CF755BE",
    "Page": 1,
    "MoreData": null,
    "HasErrors": false,
    "Contents": [{
        "Object": {
            "Token": "BI45538M6MSQG75TG6E76V63GQ3H",
            "AgentVersion": "20.0.1202.45",
            "OS": "Microsoft Windows NT 6.2.9200.0",
            "TimeZoneOffSet": "-06:00:00",
            "IsAgentBusy": false
        },
        "Errors": null,
        "Self": "http://api.getautofy.com/v2/Manage/IsActive/BI45538M6MSQG75TG6E76V63GQ3H",
        "Kind": "IsActive"
    }],
    "Errors": []
}