Баримт бичиг / API лавлах

Суулгасан санал болгол

Өөрийн бүтээгдэхүүнд санал болгох хуудас суулгах.

POST/v1/embed-tokens/referrals

Mint a one hour embed token for one of the program's users (R31). The enrollment is found by tenantId, else the partner is resolved by email and enrolled approved in the given or default group. A fresh token on every call.

Шаардлагатай API түлхүүрийн хамрах хүрээ: embed.write

Хүсэлтийн бие (MintBody)
НэрТөрөлЗаавалТайлбар
tenantIdstringтийм
partnernull | MintPartner
datastring`referrals` (default) or `analytics`.

Хариу: 200 MintOut

DELETE/v1/embed-tokens/{id}

Revoke one embed token of the key's workspace.

Шаардлагатай API түлхүүрийн хамрах хүрээ: embed.write

Параметр (1)
НэрБайрлалТөрөлЗаавалТайлбар
idpathstringтийм

Хариу: 204

GET/v1/workspaces/{workspaceId}/program/embed-settings

The program's embed settings (defaults when never saved).

Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.read

Параметр (1)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм

Хариу: 200 EmbedSettings

PUT/v1/workspaces/{workspaceId}/program/embed-settings

Save the embed settings (Business and up, program managers). Disabling revokes every live token of the program (R32).

Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write

Параметр (1)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм
Хүсэлтийн бие (EmbedSettings)
НэрТөрөлЗаавалТайлбар
enabledbooleanтийм
allowedOriginsstring[]тийм
defaultThemestringтийм`light` (default), `dark` or `system`.

Хариу: 200 EmbedSettings