Parameters
Where Doshi opens and which language it speaks, as iframe URL parameters and as SDK options.
The iframe reads its parameters off its URL, and the SDK takes them as mount options.
They mean the same thing in both.
| Parameter | Iframe URL | SDK option |
|---|---|---|
client |
? |
none: the tenant comes from the token |
edition |
? |
none: the edition comes from the token |
start |
? |
start: |
locale |
? |
locale: |
client
Section titled “client”Your client slug, from your console’s Setup values. It is never a UUID.
The iframe needs it: it is what we brand the frame with before the token lands, and what we look your allowed origins up by. A frame URL with no known slug cannot be framed at all.
The SDK takes no client. The member token already names your client, so an option
could only disagree with it.
edition
Section titled “edition”The key of one of your editions, exactly as you created it. Leave it out for your own brand.
The iframe uses it only to brand the frame before the token lands, so a member of an edition with its own brand never sees yours first. A key you never created, or one whose edition you archived, shows your own brand. That is not an error.
It decides nothing else. Which edition the member is in is the
edition claim on your assertion, and once the token lands the
member sees that edition’s brand whatever the URL said.
The SDK takes no edition. It shows nothing before the token, so there is nothing to brand.
Where Doshi opens. Leave it out for the default screen.
| Opens | Iframe URL | SDK option |
|---|---|---|
| Learn’s home | ? |
start: |
| A course | ? |
start: |
| A lesson | ? |
start: |
Copy a course’s or lesson’s id from its page in your console’s Academy. Or build the whole URL, or the SDK options, with the embed URL builder on the Setup values of Settings > Integration.
A course or lesson the member cannot open lands on Learn’s home instead. That is not an error, and neither event reports it.
Opening a course makes it the member’s course, as choosing it in Learn does: the next time they open Learn, that course is the one it continues.
The SDK checks start at mount and throws a TypeError on a view it does not know, a
course or lesson without an id, or an id on learning. The iframe cannot throw at
your page, so a start it cannot read opens Learn’s home.
locale
Section titled “locale”The language your page is written in, as a BCP 47 tag such as nl-NL.
Doshi uses it where your client speaks it: the whole tag first, then its language, so
nl-NL finds nl. A locale your client does not speak is ignored, and the member’s own
language choice, then your client’s default, applies instead.