API Integration

With our API integration features, Account Administrators can now manage select aspects of Big Universe via automated processes.

Currently our API allows you to import and edit accounts by uploading CSV files. To get started follow the steps below.

Generate an API Token

Before you can begin using the API, you must first generate a unique API Token. This token will give you access to the API without requiring you to give out your account password.

You should keep your API Token private. To ensure your token stays private, you can revoke access and generate a new token at anytime.

Generate your token via the Big Universe app's Manage section.

Prepare Your CSV Files for Import

There are 3 different type of accounts that can be imported: Schools, Teachers & Students. Each require a specifically formatted CSV file.

Important: Column heading names & order must match the following exactly.

CSV Column Headings

School: unique_id, password, school_name, first_name, last_name, email

Teacher: unique_id, password, school_username, first_name, last_name, email

Student: unique_id, password, teacher_username, school_username, first_name, last_name, grade_level

 

Import User Accounts Using the API

You can make requests to the API using a HTTP client such as curl. If you've generated an API Token, you can use the following examples to interact with the API. Be sure to replace /file/path.csv with the path to your CSV file.

Basic Example

The user import API action requires the file, username, & token parameters. The following example will import a student formatted CSV file.

Unix/Linux:
curl -i -F file=@/file/path.csv "https://www.biguniverse.com/api/v1/user_imports?token=your_api_token_here&username=budistrict"
Windows:
curl -i -k -F file=@C:\file\path.csv "https://www.biguniverse.com/api/v1/user_imports?token=your_api_token_here&username=budistrict"

Importing Students

By default, the user import API action expects a student formatted CSV file. You may also explicitly set the file_typeparameter to S to do a student import.

Unix/Linux:
curl -i -F file=@/file/path.csv "https://www.biguniverse.com/api/v1/user_imports?file_type=S&token=your_api_token_here&username=budistrict"
Windows:
curl -i -k -F file=@C:\file\path.csv "https://www.biguniverse.com/api/v1/user_imports?file_type=S&token=your_api_token_here&username=budistrict"

Importing Teachers

To import teachers, the file_type parameter is required and should be set to T.

Unix/Linux:
curl -i -F file=@/file/path.csv "https://www.biguniverse.com/api/v1/user_imports?file_type=T&token=your_api_token_here&username=budistrict"
Windows:
curl -i -k -F file=@C:\file\path.csv "https://www.biguniverse.com/api/v1/user_imports?file_type=T&token=your_api_token_here&username=budistrict"

Importing Schools

To import schools, the file_type parameter is required and should be set to A.

Unix/Linux:
curl -i -F file=@/file/path.csv "https://www.biguniverse.com/api/v1/user_imports?file_type=A&token=your_api_token_here&username=budistrict"
Windows:
curl -i -k -F file=@C:\file\path.csv "https://www.biguniverse.com/api/v1/user_imports?file_type=A&token=your_api_token_here&username=budistrict"

Notify Email(s) on Completion

You can override who gets notified when the users finish importing. Set the email_to_notify parameter to a comma separated list of email addresses.

Unix/Linux:
curl -i -F file=@/file/path.csv "https://www.biguniverse.com/api/v1/user_imports?email_to_notify=your@email.com,my@email.com&token=your_api_token_here&username=budistrict"
Windows:
curl -i -k -F file=@C:\file\path.csv "https://www.biguniverse.com/api/v1/user_imports?email_to_notify=your@email.com,my@email.com&token=your_api_token_here&username=budistrict"
Powered by Zendesk