Introduction
The BlueVolt Developer Portal is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
BlueVolt APIs
BlueVolt has 3 APIs:
Reporting API: Reporting data for billing, enrollments, categories, courses, modules, Training Tracks, and Users
User Management API: Add, update or remove users and information associated with profiles.
Salesforce API: Integrate data from your University into your Salesforce application.
How to get setup
To get started, follow these simple steps:
Sign Up - Begin by creating an account on the BlueVolt Developer Portal. This will allow you browse available APIs and manage your subscriptions.
Purchase: make sure with your University Admin has an active APIs Add-On.
Subscribe - Once signed in, select the APIs you want to use and complete the subscription process. An API Portal Admin will review your request and once approved you will be granted with unique Subscription Key and API Key, enabling secure access to each API.
Authenticate - Add the subscription key and API key to your requests and start getting data.
Subscription key vs API key
To authenticate with the APIs, two keys are needed as part of the authorization mechanism: Subscription Key and API Key. You will need 1 subscription key for your account and 1 API key per API. The “Subscription key” is populated by default and “API Key” need to be included manually. You can find your API keys under “Profile > Subscription Details > “Bluevolt Api key”.
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
Go back to BlueVolt Developer Portal.