Whitelabeling Instructions and Public API Documentation

Whitelabeling is offered to all schools on the Enterprise plan. Whitelabeling replaces our brand and logo with your own and allows students to sign up and sign in directly from your website.

The two primary places where students will see our or your logo is at the top of the student panel and on pdf handouts.

Setting up whitelableing requires having an Enterprise plan, requesting the feature, and providing a high resolution (at least 700x700px) logo and/or school name to be used. Getting this set up typically takes less than 24 hours from when we receive the image.

For security reasons, we do not allow logging in to be done on your website. Instead, we will create a custom log in page that we will host with your logo at the top. Additional customization and styling of the page is also possible. Once set up, you can add a 'log in' button on your site with a link that takes students to your custom log in page.

Automatic emails notifying students of new courses or course changes can also be customized to contain specific text and images. Once you provide us with the images and text, set up can usually be completed within 24 hours.

To enable direct enrollment in a course from your site, include this form in a page on your site:

<form action="https://app.youragora.com/api/public/v1/school/students" method="post">
  <input type="hidden" name="school_signed_id" value="SCHOOL_SIGNED_ID" />
  <input type="hidden" name="school_token" value="SCHOOL_TOKEN" />
  <input type="hidden" name="course_id" value="COURSE_ID" />
  <input type="hidden" name="redirect_url" value="https://youragora.com/forms/successfully-enrolled" />
  <div>
    <label for="email">E-mail:</label>
    <input required type="email" name="email" />
  </div>
  <div>
    <label for="first_name">First name:</label>
    <input required type="text" name="first_name" />
  </div>
  <div>
    <label for="last_name">Last name:</label>
    <input required type="text" name="last_name" />
  </div>
  <input type="submit" value="Enroll" name="submit">
</form>

SCHOOL_SIGNED_ID, SCHOOL_TOKEN and COURSE_ID are provided by Your Agora when setting up integration. All courses will use the same SCHOOL_SIGNED_ID and SCHOOL_TOKEN. If you wish to set up multiple forms for multiple courses, only change the  COURSE_ID.

To retrieve the COURSE_ID, in the school panel, click on the name of the course (for example ‘Toefl Test’) to go to the course report.

In address bar the COURSE_ID will be the number between /courses/ and /report. In this case, it is 5439.

So if the form looks like this:

<form action="https://app.youragora.com/api/public/v1/school/students" method="post">
  <input type="hidden" name="school_signed_id" value="Soas@rwq1233==-a" />
  <input type="hidden" name="school_token" value="aswrokmzdfvpwe0" />
  <input type="hidden" name="course_id" value="9021" />
  ...

Keep everything except COURSE_ID The same. In this example, change 9021 to  5439:

<form action="https://app.youragora.com/api/public/v1/school/students" method="post">
  <input type="hidden" name="school_signed_id" value="Soas@rwq1233==-a" />
  <input type="hidden" name="school_token" value="aswrokmzdfvpwe0" />
  <input type="hidden" name="course_id" value="5439" />
  ...

By default, once the form is submitted, the user will be redirected to a success page. If you like, you may change the redirect by entering a custom url.

...
<input type="hidden" name="redirect_url" value="https://youragora.com/forms/successfully-enrolled" />
  ...

The new form will now enroll students into the new course.