Developer Platform (December 2021)

Development Tools and Client Libraries

«  Remote Plugins   ·  [   home  ·   reference  ·   community   |   search  ·   index   ·  routing table   ·  scopes table   ]   ·  C#/.NET client library SDK  »

Developer Tools

We suggest the following tools for development and testing purposes:

Tool

Notes

Postman (recommended for OAuth 2.0 Apps)

Postman is a market leading API test tool. It is available for free download at www.getpostman.com. You can find Sample Postman Environments and Collections on the Brightspace Github organization. You can find information on how to connect Postman to Brightspace in the Brightspace Developer Community.

API Test Tool (ID Key Apps Only)

The API Test Tool runs in a web browser and provides an interface to point to an instance of Brightspace, supply an App ID/Key pair, and log in with a given user account. Once authenticated, you can make calls using a straightforward interface. You can find more information about using the API test tool on the Brightspace Developer Community.

Developer Sites

In order to use the Brightspace API you will require a Brightspace site to work with. Here are the options available:

Developer Persona

Notes

D2L Customers

For development and testing purposes please work with your Brightspace Administrator to determine if a non-production instance of Brightspace is available.

Brightspace Developer Group Members

As a service for Brightspace Community Developer Group members, we offer a access to a Dev Environment to enable extensibility experimentation. Members of the Developer Group can gain access to user accounts on this site. You can also use the Dev Environment to make API calls from your own custom code, experiment with LTI tools, and remote plugins. This Dev Environment is available at https://devcop.brightspace.com.

More information is on the Brightspace Developer Community.

D2L Partners

D2L makes test servers available as a paid service through our Integration Partner program. Contact the D2L Partner team for more information.

Client SDKs

The Brightspace API is a REST-like HTTP protocol API, but for various language platforms we offer a number of client library SDKs to assist your implementations.

Choosing a client SDK. In general, you can get a client SDK in two forms:

Platform

Notes

C# SDK

A simple library to help with authentication and connection to Web services from a client-side application, written using Microsoft’s .NET Framework version 3.5 or higher.

Java (SE) SDK

A simple library to help with authentication and connection to Web services from a client-side application, written in Java SE.

JavaScript SDK

JavaScript client library; available only as source code.

PHP SDK

PHP client library; available only as source code.

Python SDK

Python 3 client library.

«  Remote Plugins   ·  [   home  ·   reference  ·   community   |   search  ·   index   ·  routing table   ·  scopes table   ]   ·  C#/.NET client library SDK  »