Getting Started Guide

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

1. Viewpoint installs the Xchange Agent

After you purchase the Vista API, the Viewpoint team will work with you to install the Xchange Agent.

Although you do not have to install the Xchange Agent, for more information about this process, see the following article: What is the Xchange Agent and how do I install it?

2. Viewpoint sets up a SQL service user

The Viewpoint team will set up a SQL user with credentials for accessing your Vista database through the Xchange Agent.

Again, although you do not have to set up this user, for more information about the SQL user, see the following article: How to Set Up Your Viewpoint Vista SQL User for the Xchange Agent.

3. Connect the API to your instance of Vista

After verifying that the Xchange Agent is set up with permissions to read and write data to your Vista database, you can select the specific Vista modules and endpoints within those modules that you want to enable through the API.

For details, see How to Connect the Xchange-Agent to Viewpoint Cloud.

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.

4. Set up 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 specific token assigned to that particular third-party vendor. This token includes limited permissions to grant access to only the specific area(s) of Vista that you want the vendor to access. Request this token from Support.

5. 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.