Skip to main content

Getting Started

  • Updated

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:

  1. Sign Up - Begin by creating an account on the BlueVolt Developer Portal. This will allow you browse available APIs and request APIs Keys.

  2. Purchase add-ons - If you’re already purchased an API add-on, you can start requesting keys. If you haven’t yet purchased an add-on, reach out to your CSM.

  3. Request API Keys - Once signed in, select the APIs you want to use and Request Keys. An API Portal Admin will review your request and once approved you will be granted with unique Primary Key and API Key, enabling secure access to each API.

  4. Authenticate - Add the Primary key and API key to your header requests and start getting data.

Primary key vs API key

To interact with the APIs through the Developer Portal Console, two keys are needed to authenticate requests:

  • Primary Key

  • API Key

You can find your API keys under “Profile > API Keys > “API key”

Reporting.pngProfile.png

Making your first request

Your first request should include the:

  • API URL

  • Primary Key

  • API key

Sample request 

GET https://apigw.bluevolt.com/devapi2/webapi/v2/GetAllCourses?apiKey=4be74c3598a14e7ea8ca7851f05be678

Request Headers
Ocp-Apim-Subscription-Key: 3b1c4c01c38f42768ab98a3a8dafa0bb
User-Agent: PostmanRuntime/7.43.0
Accept: */*
Cache-Control: no-cache
Postman-Token: 996db56c-716c-4f9e-90d3-7ec58de2971d
Host: apigw.bluevolt.com
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Cookie: .ASPXANONYMOUS=I2McnWeoHUFoA1Niv9OuSXxV1xL9D_lr1eeCLJirNbk5eqQlPF5VyAo5C1WfWeBUf2F9v_ZKZQEHQbS-U3_rgjjMCkNp1MHpt1q64a7KPTAhQQfq0; MachineID=37391834-1add-4b64-8fdc-cf2412cc9ed6

Header requests

Your Header requests should include:

  • Key: ocp-apim-subscription-key

  • Value: Primary 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.

If you have any questions or require support during this transition, please contact our team to support@bluevolt.com.

Go back to BlueVolt Developer Portal.

Related articles