Getting Started Guide

Go through the following steps to complete setup and start using the Vista API.

1. App Xchange coordinates with Vista to setp

The following is provided for your information only. App Xchange and the Vista team will handle the following.

Install the Xchange Agent:

After you purchase the Vista API, the our team will work with you to install the Xchange Agent. After verifying that the Xchange Agent is set up with permissions to read and write data to your Vista database,

Although you do not have to install the Xchange Agent, for more information about this process, see the following article: Install the App Xchange Agent

NOTE: If you want to test API calls before connecting to your production Vista instance, you can purchase and connect a test environment to your Vista test instance.

Set up a SQL User:

We will also set up a SQL user with credentials for accessing your Vista database through the Xchange Agent. You can define specific Vista modules and endpoints you want to enable through the API.

Again, although you do not have to set up this user, for more information about the SQL user, see the following article: Create a Vista SQL User for the App Xchange Agent.

2. Request third-party access (if applicable)

Complete this step only if you want to allow third-party access to the Vista API. You would do this in the case that you are setting up a custom integration.

You will need a new specific API key assigned to that particular third-party vendor. This API key includes limited permissions to grant access to only the specific area(s) of Vista that you want the vendor to access. Request this API key during onboarding or later from your customer portal or from Support.

3. Specify resources

Submit your desired resources via your customer portal to have them added to your API Key authorization.

4. Make your first API call

After completing the above setup, prepare to make your first API call by first reviewing the API Reference documentation to learn more about the endpoints.

Also make sure to have your API key and subscriber code, which were provided during the setup steps above. You will need these to make and authenticate requests.