Getting Started_old

We're thrilled that you want to use Autofy to provide integration to your customers. Before you start your integration journey, we wanted to share a few tips and best practices.

You're In The Right Place

Everything you need to build and test your integration is right here. Be sure to read the documentation thoroughly to make sure you're getting everything you need from the platform. But if you have any questions, please reach out and the team will be glad to help.


Your TRIAL API key comes with some restrictions:

  • You can only connect up to 5 companies
  • No bulk actions for GET calls are supported (such as getting all records or modTimeStart/modTimeEnd requests)
  • Your access to the API will expire after 30 days

Next, set up a trial environment you can use to evaluate Autofy. We recommend a local server that you manage, or a Right Networks account. During your trial, focus on understanding the following:

  • How the connection process works for the accounting app you're integrating with. For example, for Quickbooks Desktop we offer documentation here.
  • How to add or remove companies from Autofy.
  • The difference between your API Key and the Agent Token, which is called out in our authentication guide.

Plan Your Integration Flow

While Autofy can help you get access to the data you need, you will need to plan out what calls to make (and when) to support the data flow that your users want. Make a flow diagram that describes all the actions you'll need to take to enable your desired data flow.

Once you know what data you'll need and when, integrate this into how your user experience works. For instance, if you make a mass mail app, you would get all your customers' customer records and store them on your side, refreshing as necessary, rather than making realtime calls for individual records.

Set Up Postman

While you can of course use any environment you choose to build out a quick proof-of-concept, we recommend Postman. We love Postman, because it lets you quickly and easily test APIs. That's why we've created a collection that you can download here. You'll also find our collection in the left nav menu. If you have any questions about how to use Postman, their documentation is excellent, and we'd love to answer any Postman question you have that's specific to Autofy.

What’s Next
Did this page help you?