Converting To V2

If you currently use v1 of the Autofy API and wish to convert your implementation to v2, this guide will walk you through a complete list of changes to make, as well as highlight what stays the same.

Changes

Headers:

  • There is a new header to include, SchemaVersion, which declares which version of Autofy JSON you'll be using in your request. The default value you can use for this is 20.04. Reference our v2 documentation for the latest version.
  • The name of the authorization header is now x-api-key.

JSON:

  • Field names and the positions of some fields in Autofy JSON may differ slightly. Reference the /meta/ endpoint to get the latest JSON for your implementation.
  • The full response JSON has been enhanced to provide more information.

URLs:

  • The base URL for making calls in v2 is https://api.getautofy.com/.
  • Resources are grouped under /data/, /meta/, and /manage/ URLs.
  • There are new query parameters to consider. Reference our v2 documentation for a full description.

Agent:

  • If you used v1 before 3/31/2020, be sure to upgrade to the latest Agent, which is found in our v2 docs.

Staying The Same

Keep in mind that even though certain things are different in v2, anything not mentioned above will be the same, notably:

  • Your API key
  • User IDs and Endpoint IDs that you provisioned

If you have any questions about this conversion, please send us a message, and we'll be happy to help.