For Developers

Integrating with Eduplaces

Overview

At a high level, integrating your Application with Eduplaces consists of three steps:

  1. Get approved by Eduplaces.
  2. Configure the Eduplaces Source in the Edlink Dashboard.
  3. Configure your App in Eduplaces Launchpad.

After this process, students will be able to launch your App from the Eduplaces Launchpad, and your App will have access to basic rostering information from connected schools and people.

Get Approved by Eduplaces

To integrate with Eduplaces via Edlink, follow these steps:

  1. Fill out Eduplaces Partners Form A company representative must fill out the form.
  2. Get Client ID and Client Secret from Eduplaces After discussing your app and getting approval from Eduplaces, they will set up an environemnt for you, with a Client ID and Secret.
  3. Edlink Redirect URL Eduplaces might require a "Redirect URL". If so, we use https://ed.link/api/authentication/eduplaces/:application_id where :application_id is replaced with your Edlink application ID.

❓ Not sure what your application ID is? Contact our support team.

Note: Eduplaces may ask what scopes they should approve. Please see the technical details for answers.

The goal here is to tell Edlink your Eduplaces Client ID and Client Secret, so that we can actually do things in their system on your behalf.

  1. Visit the Data Providers page in the Edlink Dashboard.
  2. Click Configure in the "Configure Eduplaces" section. Configure Eduplaces Example
  3. Fill in the Client ID and Client Secret.
Configure Eduplaces Drawer Example

Configure your App in the Eduplaces Launchpad

⚠️ You must be an Eduplaces Teacher to add the App to the Launchpad.

Adding the App to Eduplaces Launchpad for SSO

Note: if you do not speak German, we recommend setting your browser to auto-translate these pages to English.

  1. Log into Eduplaces Launchpad Log into your Eduplaces Launchpad with as an admin/teacher account.
  2. Add the App to the Eduplaces Launchpad Use the search bar, and find the App you want. Click add. It should now appear in the "My Apps" section.
  3. Set up the App
    • Click on the app from the Launchpad. Click "Set up the app" in the popup modal.
    • A two-sided interface with "Unlock app" and "Transfer - In the modal that follows, select the accounts you want to grant access to (probably everyone) by clicking on them.
    • The next screen has a "Transfer - Again, select the - Now, at the bottom in the section labeled "Apply settings for {app name}," select "Apply settings."

Your school is now connected to Edlink. Once validated, your organization's data will sync with the Edlink dashboard within 24 hours.

Any Questions?

If you have any questions or encounter issues, please contact our support team. We'll respond within 24 business hours.

Verify your SSO Launch

  1. Navigate to the Eduplaces Launchpad.
  2. Click on your App Tile.
  3. Verify that the flow successfully completes with a redirect to your application.