Skip to content

Postman collection and setup guide for working with the Blackboard Learn REST APIs, including authentication and example requests.

License

Notifications You must be signed in to change notification settings

Karl-Horning/blackboard-learn-apis-postman-collection

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📘 Blackboard Learn APIs – Postman Collection


📖 Table of Contents


🤓 Overview

A Postman collection for working with the Blackboard Learn REST APIs, as documented on Anthology's Developer Portal. It includes endpoints for authentication, user and course management, content access, and more.


🛠️ Pre-requisites

Before using this collection, define the following Global Variables in Postman:

Variable Description
baseUrl Your Blackboard Learn instance base URL (for example, https://yourinstitution.learn.blackboard.com)
basicAuthUsername Your Application Key (Client ID), created in Anthology's Developer Portal following the instructions on Basic Authentication with REST
basicAuthPassword Your Application Secret (Client Secret), paired with the Application Key

These credentials are used to authenticate via Basic Auth and retrieve an OAuth 2.0 token.


🔐 Authentication Workflow

  1. Send a POST request to:

    {{baseUrl}}/learn/api/public/v1/oauth2/token
  2. Your basicAuthUsername and basicAuthPassword are sent via Basic Auth.

  3. The response returns an access_token, which is saved in the apiKey environment variable.

  4. This token is automatically used for future requests by setting the header:

    Authorization: Bearer {{apiKey}}

⚠️ Be sure to retrieve an access token before calling any other endpoints.


🚀 Using the Collection

  • Endpoints are grouped by category (for example, Users, Courses, Enrolments).
  • Some requests require specific parameters such as userId or courseId.
  • Postman scripts are included to handle token storage and variable assignment.
  • Supports chaining requests and managing dynamic workflows with variables and pre-request scripts.

📦 Installation

To install the collection:

git clone https://github.com/Karl-Horning/blackboard-learn-postman.git
cd blackboard-learn-postman

Then follow Step 2: Import the Swagger File into Postman in this guide: 👉 Using Blackboard's Swagger File to Create a Postman Collection and Make an API Call


📚 Further Reading


📄 Licence

MIT © 2025 Karl Horning


👤 Author

Made with ❤️ by Karl Horning

About

Postman collection and setup guide for working with the Blackboard Learn REST APIs, including authentication and example requests.

Topics

Resources

License

Stars

Watchers

Forks