Authentication

As is common with most APIs, only authenticated apps are authorized to make requests. To get authenticated access to the Autofy API, you'll need a key, which is used to identify your application on the Autofy API. You'll use it in every request your application makes. If you have multiple apps you'd like to connect to Autofy, you'll need multiple keys - one for each app.

📘

API Keys vs. Agent Tokens

As you start your implementation to the API, remember not to mix up your API key with the Agent Token:

--> The API Key is what you need to make any calls to the API.
--> The Agent Token is what you enter into the Agent to log it into Autofy.

Using Your Key

To use the key in your requests, set a header called x-api-key, with your API key as the value. Before you start making requests, be sure to follow the steps in the rest of this section.

In this example, we're calling Autofy to retrieve a Customer from a specific company file, with placeholders for endpointID, the Customer's ID, and your API key.

curl --request GET \
  --url 'https://api.getautofy.com/v2/data/{edpointID}/customer/{ID} \
  --header 'cache-control: no-cache'
  --header 'x-api-key: {YOUR_API_KEY}' \