Get Started with the Brillium Web API

Create applications that access Brillium data forby using the Brillium RESTful Web API.

Configuring Your Master Account Workspace

By default, the Web API is disabled for a new or existing Brillium master account workspace. It must be enabled and an API password must be set in order for any of the functionality in this guide to be used. Follow the steps below to configure your workspace.

  1. Sign into your Brillium administrator account workspace. This is typically the first account that was created. You can only enable the API by signing into the master account workspace.
  2. Click on Settings icon () .
  3. Click on API.
  4. Select Yes from the Enable dropdown.
  5. Enter an API Password and re-enter the password to confirm it is entered correctly.
  6. Record the Account ID, API Password you entered, and the Security Token and store it in a safe place. You will need this information to access the API through your application.
  7. Click the Save button to save the configuration and enable API access to your Brillium data.

The API Password

It is important to note that the API Password is separate and distinct from the password you use to sign into Brillium’s administrative and authoring environment. When one password is changed, it does not change the other password.

How to Change the API Password

To change the API password, return to the API Configuration screen and enter a new password and confirm it. Optionally, the Security Token can be changed by selecting the Change button beside the Security Token. Select the Save button to save any changes.

WARNING
Changing your API Password or Security Token will invalidate the previous tokens. Update any applications that access the Brillium API with the new authentication information.

Authentication/Authorization HTTP Header

To authenticate with the Brillium Web API, you must create an authorization token and include it along in HTTP headers for each API request. To create an authorization token, you use the account ID Brillium master account workspace, the API Password, and the Security Token. These were determined in the “Configuring Your Master Account” section above.

For example, assume the following values:

Account Workspace ID: SUPERSUDS
API Password: password123
Security Token: b6e60bfb08994be79e17e35656e3246e

The token is created by placing all elements together in a single text string with no spaces. The form of the token is as follows:

WORKSPACE ID:API Password and Security Token.

 

EXAMPLE

SUPERSUDS:password123b6e60bfb08994be79e17e35656e3246e

 

This authentication string needs to be Base-64 encoded. When completed, it should look similar to the following example:

U1VQRVJTVURTOnBhc3N3b3JkMTIzYjZlNjBiZmIwODk5NGJlNzllMTdlMzU2NTZlMzI0NmU= 

This encoded authentication string must be included as an “Authorization” HTTP header with all API requests:

Authorization: Basic U1VQRVJTVURTOnBhc3N3b3JkMTIzYjZlNjBiZmIwODk5NGJlNzllMTdlMzU2NTZlMzI0NmU=

Using a Specific API Version

If it is necessary to make an API request using a particular version of the APIl, provide the version number in the “Accept” HTTP Header. In the following example version 1 of the API response is being requested in JSON format.

NOTE

Below is an example of a request (in JSON format) for an API request that targets an assessment with the ID of “MATH101”.

Accept: application/vnd.ingeniousgroup.testcraftapi-v1+json

 

LEARN MORE

Download the Brillium WEbAPI Technical Guide: Brillium WebAPI Guide