The compatibility API aims to provide limited backward compatibility of Bracken 2 data to Bracken 1 enabled integration partners.
The endpoints correspond to routes at https://<tenant>.brackenlearning.com/rest2/.
Log in a user and display a lesson.
If the user account does not exist, it is created using the supplied profile
information. Each user account is uniquely identified by its Username.
This endpoint can be used to log in to both Bracken 1 and Bracken 2:
Secret and JoinCode corresponds to a Bracken 2
lesson ID.Token and JoinCode to correspond to a
Bracken 1 zone.The content is a x-www-form-urlencoded form post with fields:
| Property | Sample value | Description |
|---|---|---|
Domain |
demo | The integration client_id, i.e. the Bracken domain.¹ |
Token |
3ou3xNJ3 | The OAuth2_secret for Bracken 1 logins. |
Secret |
af3cb384-... | The integration client_secret for Bracken 2 logins. |
JoinCode |
233 | The Bracken 1 join code, or Bracken 2 lesson identifier.² |
Username |
testuser | Username to create or use, must be unique. |
Firstname |
Charlie | First (given) name of user. |
Lastname |
Brown | Last (family) name of user. |
Email |
aoeu@me.com | Email of user. |
Notes:
The response is an HTML document containing a self-submitting form, e.g.
<!DOCTYPE html>
<html>
<form>
<input type="hidden" name="id_token" value="..." />
</form>
<script>
document.forms[0].submit();
</script>
</html>