Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Solarvista Prerequisites

Requirements

To connect to Solarvista you will need the following:

  • an account for Solarvista with API access.
  • the AccountId for your Solarvista account. Please contact your Account Manager if you don’t know what this is.
  • a Client ID to create your access token and credentials. Your Solarvista administrator should be able to provide you with this.
  • You will need to have Postman installed.

If you do not have a Solarvista account with API access you will need to ask your administrator to create one for you.

Postman is an application used mainly by developers to create, share, test and document APIs. We use it in this set up guide to get the authentication details from your Solarvista API.

Postman Setup

Once you have Postman downloaded and installed, you should download our Solarvista Postman Collection.

https://www.matatika.com/docs/solarvista_postman_collection.json

Below are links to useful Postman Documentation that will help you with the Solarvista API Access Setup:

Importing the Solarvista Postman Collection

Once you have postman install and running:

  1. Download our Solarvista Postman Collection.
  2. Create or enter a Postman Workspace.
  3. Click the Import button, found just left of the top of the main center screen.
  4. Drag and drop, or browse to the solarvista_postman_collection.json you downloaded onto the window.
  5. Now you should see Solarvista API in your list of collections.

Solarvista API Access Setup

  1. Download and Import our Solarvista Postman Collection
  2. Click on the name of the collection in the list of collections on the left hand side of Postman.
  3. Click on the three dots at the end of the name.
  4. In center of your screen the Solarvista collection will have opened. Click on the Variables tab just below the name.
  5. Set the account variable in Postman to your Solarvista AccountId.
  6. Set the setupClientId variable in postman to the Client ID supplied to you by the administrator of your Solarvista API.
  7. In the tabs where you found Variables, click on Authorization.
  8. Scroll to the bottom of the Authorization tab and click Get New Access Token.
  9. A window will pop up, click through the options and select the account you with to generate this token for.
  10. After choosing your account, the window will countdown from 5, and then display a MANAGE ACCESS TOKENS window. Click Use Token in the top right.
  11. Expand the collection in the list of the left hand side of Postman, and click on Setup Token right at the bottom.
  12. Click the Send button in the top right.
  13. You will then get a response in the bottom center of Postman with your clientId and code which are required for a Solarvista Pipeline.
  14. (Optional) In the collection list on the left hand side of postman, there is a POST request called Work-Items. Click this and click the Send button. If you get a list of Work Items as the response, you know you have API access on your user account.

If at any stage you get a message saying you do not have access to this API, you will need to get you administrator to update your account’s permissions.