To connect to Solarvista you will need the following:
- an account for Solarvista with API access.
AccountIdfor your Solarvista account. Please contact your Account Manager if you don’t know what this is.
Client IDto 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.
Once you have Postman downloaded and installed, you should download our Solarvista Postman Collection.
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:
- Download our Solarvista Postman Collection.
- Create or enter a Postman Workspace.
- Click the Import button, found just left of the top of the main center screen.
- Drag and drop, or browse to the solarvista_postman_collection.json you downloaded onto the window.
- Now you should see Solarvista API in your list of collections.
Solarvista API Access Setup
- Download and Import our Solarvista Postman Collection
- Click on the name of the collection in the list of collections on the left hand side of Postman.
- Click on the three dots at the end of the name.
- In center of your screen the Solarvista collection will have opened. Click on the
Variablestab just below the name.
- Set the
accountvariable in Postman to your Solarvista
- Set the
setupClientIdvariable in postman to the
Client IDsupplied to you by the administrator of your Solarvista API.
- In the tabs where you found
Variables, click on
- Scroll to the bottom of the
Authorizationtab and click
Get New Access Token.
- A window will pop up, click through the options and select the account you with to generate this token for.
- After choosing your account, the window will countdown from 5, and then display a
MANAGE ACCESS TOKENSwindow. Click
Use Tokenin the top right.
- Expand the collection in the list of the left hand side of Postman, and click on
Setup Tokenright at the bottom.
- Click the
Sendbutton in the top right.
- You will then get a response in the bottom center of Postman with your
codewhich are required for a Solarvista Pipeline.
- (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.