Once you have your API key and have gotten familiar with authentication, you can create your first user.

What's a user?

Within the Autofy API, a User is a entity that communicates with our platform. For on premise applications, a user is synonymous with an agentToken, which gets entered into an Agent (which you'll learn about in the next section of this guide). For cloud apps, no Agent is needed, however you'll still need to create a user.

Create a user

Calling this POST method will return you an object containing a userID and agentToken. Store the userID and agentToken on your end. If your end user is connecting to an on-premise accounting app like QuickBooks Desktop, give them the agentToken to put in the Agent. Later, you'll tell the Agent to connect to the accounting app.

Call this URL to create a new user.

https://api.getautofy.com/v2/manage/user

Request:

curl --request POST \
  --url https://api.getautofy.com/v2/manage/user \
  --header 'cache-control: no-cache' \
  --header 'content-type: application/json' \
  --header 'x-api-key: {YOUR_API_KEY}' \
  --data '{"agentToken":"","companyId":"","dateTimeCreated":"","externalId":"","id":"","isActive":true}'

Response:

Autofy will respond with a user object. Store the agentToken and pass to your user to enter into their Autofy Agent.

{
    "Self": "https://api.getautofy.com/v2/Manage/user",
    "Kind": null,
    "RequestId": "8F1NCQW3C9",
    "Page": 1,
    "Contents": [
        {
            "Object": {
                "agentToken": "PW4P1KLZIHWA3M8IM7OFSDBGDXXX",
                "companyId": "",
                "dateTimeCreated": "2020-06-11T20:29:31.2954836+00:00",
                "externalId": "",
                "id": "xxxxx",
                "isActive": true
            },
            "Errors": null,
            "Self": null,
            "Kind": "user"
        }
    ],
    "Errors": []
}