Using the Vega API

The Vega API is not officially released yet but is made available for evaluation purposes as an unfinished work in progress. As such, it is not covered by Vega Support and using the API is equivalent to agreeing to this condition.

Please use at your own risk. 

The API uses the Open API specification (formerly Swagger). You can find documentation and tools for that here: http://swagger.io

To access the Vega API you need to have a username and password. These are only available once you're logged into Vega and can be found here: dashboard.vega.works/admin/api_auth.aspx

The Client ID is the username for the API and should be used with the API Password in any requests.

The list of API endpoints and how to use them can be found here: api.vega.works/help/index

Here's a sample curl request that will get a list of all supporters in my demo organisation:

curl -u 0C421337-E526-4BF0-807A-C6788A8FF58E:F08w6G8jW98VedsqUtci0knEzZW5D6eQhaC8s1L6X4 https://api.vega.works/api/Supporters

This will return a JSON file with the supporter data. Note - you'll need to substitute the username and password for your own version or you'll get an error.

This is a sample request in PHP:

 $username = "0C421337-E526-4BF0-807A-C6788A8FF58E";
 $password = "F08w6G8jW98VedsqUtci0knEzZW5D6eQhaC8s1L6X4";
 $remote_url = 'https://api.vega.works/api/Supporters';
 
 $opts = array(
   'http'=>array(
     'method'=>"GET",
     'header' => "Authorization: Basic " . base64_encode("$username:$password")                 
   )
 );
 
 $context = stream_context_create($opts);
 $supporterList = file_get_contents($remote_url, false, $context);
 
 print($supporterList);