Authenticatie
Voor elke API-aanroep is een authenticatietoken vereist als onderdeel van de body of de query van het verzoek. Wanneer u bent aangemeld, vindt u uw token door op de browserextensie van Panorama te klikken. Geef deze parameter in uw verzoek de naam authentication Token.
Transport en codering
De huidige API ondersteunt alleen het JSON-gegevensformaat. Het wordt aanbevolen om application/json op te geven als geaccepteerde header, maar dat is niet verplicht.
Basis-URL van de API
De basis-URL voor de Panorama API is afhankelijk van de zone waarin uw instelling is geregistreerd. Als u niet zeker weet in welke zone uw instelling zich bevindt, neem dan contact op met uw accountmanager. Om beveiligingsredenen is alleen https-toegang toegestaan.
Voor de modellen Gebruiker, Instelling, Cursus, Periode en Subaccount:
Amerikaanse zone: https://panorama.yuja.com/api
Canadese zone: https://panorama-cz.yuja.com/api
Europese zone: https://panorama-ez.yuja.com/api
Australische zone: https://panorama-az.yuja.com/api
Voor de documentmodellen:
Amerikaanse zone: https://panorama-api.yuja.com/
Canadese zone: https://panorama-api-cz.yuja.com/
Europese zone: https://panorama-api-ez.yuja.com/
Australische zone: https://panorama-api-az.yuja.com/
Antwoordcodes van de REST-API
| Statuscode | Betekenis |
| 200 | OK |
| 201 | Aangemaakt |
| 204 | Geen inhoud |
| 400 | Ongeldig verzoek |
| 401 | Niet geautoriseerd |
| 403 | Verboden |
| 404 | Niet gevonden |
| 500 | Interne serverfout |
| 502 | Ongeldige gateway |
Modellen
De Panorama API is opgedeeld in meerdere modellen, die elk een andere entiteit vertegenwoordigen, zoals cursussen of documenten. De onderstaande modellen bevatten mogelijk niet alle beschikbare velden en tonen alleen de kernvelden van het betreffende model.
1 - Overzicht van de API van het gebruikersmodel
Het gebruikersmodel vertegenwoordigt alle personen die zijn gekoppeld aan het opgegeven toegangstoken of deel uitmaken van de instelling.
1.1 - Kern van de gebruikersmodellen
| Variabele | Type | Beschrijving |
| userId | string | Een unieke userId die door het systeem wordt gegenereerd. |
| lmsUserId | string | De userId die uw LMS voor de gebruiker heeft gegenereerd. |
| string | Het e-mailadres van de gebruiker. | |
| firstName | string | De voornaam van de gebruiker. |
| lastName | string | De achternaam van de gebruiker. |
| role | string | De systeemrol van de gebruiker. |
| locked | boolean | Of de systeemrol van deze gebruiker al dan niet is vergrendeld. |
1.2 - Belangrijkste endpoints
| Methode | Pad | Beschrijving | Vereist toegangsniveau |
| GET | /user/getUser | Haalt de huidige gebruiker op die is gekoppeld aan het opgegeven toegangstoken. | Student |
| GET | /user/getPaginatedUsers | Haalt een array op met gebruikers in uw instelling. | Beheerder |
| POST | /user/updateUserInfo | Werkt de voornaam, achternaam en het e-mailadres van de gebruiker bij. | Beheerder |
1.2.1 - GET /user/getUser
Haalt de huidige gebruiker op die is gekoppeld aan het opgegeven toegangstoken.
Voorbeeld-URL: https://panorama.yuja.com/api/user/getUser
Parameter:
Naam |
Type |
Beschrijving |
|---|---|---|
authenticationToken |
string |
Het authenticatietoken van de gebruiker. Wordt gebruikt om het verzoek te authenticeren. |
Voorbeeld van JSON-gegevens:
{"authenticationToken": "1129c18a-eb75-4a11-8ccc-566646f94tvc"}
1.2.2 - GET /user/getPaginatedUsers
Haalt een array op met gebruikers in uw instelling.
Voorbeeld-URL: https://panorama.yuja.com/api/user/getPaginatedUsers
Parameters:
Naam |
Type |
Beschrijving |
|---|---|---|
authenticationToken |
string |
Het authenticatietoken van de gebruiker. Wordt gebruikt om het verzoek te authenticeren. |
page |
integer |
Een unieke userId die door het systeem wordt gegenereerd. |
pageSize |
integer |
Het aantal records dat op elke pagina wordt ontvangen. |
Voorbeeld van een JSON-verzoek:
{"authenticationToken": "1129c18a-eb75-4a11-8ccc-566646f94tcc","page": 2,"pageSize": 10}
1.2.3 - POST /user/updateUserInfo
Werkt de voornaam, achternaam en het e-mailadres van de gebruiker bij.
Voorbeeld-URL: https://panorama.yuja.com/api/user/updateUserInfo
Parameters:
Naam |
Type |
Beschrijving |
|---|---|---|
authenticationToken |
string |
Het authenticatietoken van de gebruiker. Wordt gebruikt om het verzoek te authenticeren. |
userId |
string |
De unieke userId van de gebruiker die wordt bijgewerkt. |
firstName |
string |
De voornaam van de gebruiker. |
| lastName | string | De achternaam van de gebruiker. |
| string | Het e-mailadres van de gebruiker. |
Voorbeeld van een JSON-verzoek:
{"authenticationToken": "1129c18a-eb75-4a11-8ccc-566646f94tcc","userId": "2ffdc6e2-b250-4c53-b706-d4e2856beaeb","firstName": "Lauren","lastName": Barnes","email": "lauren.barnes@mail.utoronto.ca"}
2 - Overzicht van de API van het subaccountmodel
Het subaccountmodel vertegenwoordigt alle subaccounts die beschikbaar zijn voor de persoon die de API gebruikt.
2.1 - Kern van het subaccountmodel
Variabele |
Type |
Beschrijving |
|---|---|---|
subAccountId |
string |
Een unieke subAccountId die door het systeem wordt gegenereerd. |
parentSubAccountId |
string |
Een unieke subAccountId die door het systeem wordt gegenereerd voor het bovenliggende subaccount van het subaccount. |
lmsSubAccountId |
string |
De subAccountId die uw LMS voor het subaccount heeft gegenereerd. |
lmsParentSubAccountId |
string |
De subAccountId die uw LMS heeft gegenereerd voor het bovenliggende subaccount van het subaccount. |
name |
string |
De naam van het subaccount. |
2.2 - Belangrijkste endpoints
Methode |
Pad |
Beschrijving |
Vereist toegangsniveau |
|---|---|---|---|
GET |
/subAccount/getPaginatedSubAccounts |
Haalt een lijst op met subaccounts in uw instelling waartoe u toegang hebt. |
Subbeheerder |
2.2.1 - GET /subAccount/getPaginatedSubAccounts
Haalt een lijst op met subaccounts in uw instelling waartoe u toegang hebt.
Voorbeeld-URL: https://panorama.yuja.com/api/subAccount/getPaginatedSubAccounts
Parameters:
Naam |
Type |
Beschrijving |
|---|---|---|
authenticationToken |
string |
Het authenticatietoken van de gebruiker. Wordt gebruikt om het verzoek te authenticeren. |
page |
integer |
De pagina waarmee wordt begonnen (begint bij 1). |
pageSize |
integer |
Het aantal records dat op elke pagina wordt ontvangen. |
Voorbeeld van JSON-gegevens:
{"authenticationToken": "1129c18a-eb75-4a11-8ccc-566646f94tcc","page": 2,"pageSize": 10}
3 - Overzicht van de API van het periodemodel
Het periodemodel vertegenwoordigt alle perioden die beschikbaar zijn voor de persoon die de API gebruikt.
3.1 - Kern van het periodemodel
Variabele |
Type |
Beschrijving |
|---|---|---|
termId |
string |
Een unieke termId die door het systeem wordt gegenereerd. |
lmsTermId |
string |
De termId die uw LMS voor de periode heeft gegenereerd. |
name |
string |
De naam van het subaccount. |
start |
Date |
De startdatum van de periode. |
end |
Date |
De einddatum van de periode. |
3.2 - Hoofdendpoints van het periodemodel
Methode |
Pad |
Beschrijving |
Vereist toegangsniveau |
|---|---|---|---|
GET |
/term/getPaginatedTerms |
Haalt een array met perioden van uw instelling op. |
Docent |
3.2.1 - GET /term/getPaginatedTerms
Voorbeeld-URL: https://panorama.yuja.com/api/term/getPaginatedTerms
Haalt een array met perioden van uw instelling op.
Parameters:
Naam |
Type |
Beschrijving |
|---|---|---|
authenticationToken |
string |
Het authenticatietoken van de gebruiker. Wordt gebruikt om het verzoek te authenticeren. |
page |
integer |
De pagina waarmee wordt begonnen (begint bij 1). |
pageSize |
integer |
Het aantal records dat per pagina wordt ontvangen. |
Voorbeeld-JSON-gegevens:
{"authenticationToken": "1129c18a-eb75-4a11-8ccc-566646f94tcc","page": 2,"pageSize": 10}
4 - Overzicht van de API voor het instellingsmodel
Het instellingsmodel haalt informatie op waartoe beheerders en subbeheerders toegang hebben, zoals instellingsrapporten, inhoudsrapporten en problemenrapporten.
4.1 - Kern van het instellingsmodel
Variabele |
Type |
Beschrijving |
|---|---|---|
institutionId |
string |
Een unieke institutionId die door het systeem wordt gegenereerd. |
lmsType |
string |
Het type LMS dat aan de instelling is gekoppeld (bijv. Canvas). |
name |
string |
De naam van de instelling. |
primaryIdentifierKey |
string |
Een unieke identificatiesleutel die door het systeem wordt gegenereerd. |
secondaryIdentifierKey |
string |
Een unieke secundaire identificatiesleutel die door het systeem wordt gegenereerd. |
consumerKey |
string |
Een unieke sleutel die door het systeem wordt gegenereerd voor gebruik met LTI 1.1. |
ltiSecret |
string |
Een unieke sleutel die door het systeem wordt gegenereerd voor gebruik met LTI 1.1. |
clientId |
string |
De client-ID die aan de instelling is gekoppeld. Wordt gebruikt voor LTI 1.3. |
deploymentId |
string |
De implementatie-ID die aan een LTI-implementatie is gekoppeld. Wordt gebruikt voor LTI 1.3. |
iss |
string |
De uitgever (issuer) die aan de instelling is gekoppeld. Wordt gebruikt voor LTI 1.3. |
OIDCEndpoint |
string |
Het OIDC-endpoint van de instelling. Wordt gebruikt voor LTI 1.3. |
JWKSEndpoint |
string |
Het JWKS-endpoint van de instelling. Wordt gebruikt voor LTI 1.3. |
domain |
string |
Het domein van de instelling. |
lmsAPILink |
string |
Het API-endpoint dat aan de instelling is gekoppeld. |
accessToken |
string |
Het toegangstoken van de instelling. Wordt gebruikt voor API-verzoeken aan de instelling. |
4.2 - Hoofdendpoints van het instellingsmodel
Methode |
Pad |
Beschrijving |
Vereist toegangsniveau |
|---|---|---|---|
GET |
/institution/getInstitutionInformation |
Haalt informatie op over de instelling die aan uw account is gekoppeld. |
Beheerder |
GET |
/institution/exportInstitutionReport |
Downloadt een toegankelijkheidsrapport voor de gekoppelde instelling. Het kan worden gefilterd op subaccounts en perioden waartoe u toegang hebt. |
Subbeheerder |
GET |
/content/exportContentReportData |
Downloadt een inhoudsrapport voor de gekoppelde instelling. Het kan worden gefilterd op subaccounts en perioden waartoe u toegang hebt. |
Subbeheerder |
GET |
/issue/exportIssuesReport |
Downloadt het problemenrapport voor de gekoppelde instelling. Het kan worden gefilterd op subaccounts en perioden waartoe u toegang hebt. |
Subbeheerder |
4.2.1 - GET /institution/getInstitutionInformation
Haalt informatie op over de instelling die aan uw account is gekoppeld.
Voorbeeld-URL: https://panorama.yuja.com/api/institution/getInstitutionInformation
Parameters:
Naam |
Type |
Beschrijving |
|---|---|---|
authenticationToken |
string |
Het authenticatietoken van de gebruiker. Wordt gebruikt om het verzoek te authenticeren. |
Voorbeeld-JSON-gegevens:
{"authenticationToken": "1129c18a-eb75-4a11-8ccc-566646f94tcc"}
4.2.2 - GET /institution/exportInstitutionReport
Verstuur het LMS-toegankelijkheidsrapport per e-mail en download het. Dit rapport kan worden gefilterd op subaccounts en perioden, zodat u alle relevante gegevens voor uw instelling en cursussen kunt bekijken.
Voorbeeld-URL: https://panorama.yuja.com/api/institution/exportInstitutionReport
Parameters:
Naam |
Type |
Beschrijving |
|---|---|---|
authenticationToken |
string |
Het authenticatietoken van de gebruiker. Wordt gebruikt om het verzoek te authenticeren. |
subAccountId |
string |
De subaccount-ID waarop u het rapport wilt filteren. Optioneel. |
terms |
array |
De periode-ID en periodenaam waarop u het rapport wilt filteren. Optioneel. |
string |
Het e-mailadres dat het rapport ontvangt. |
|
shouldEmail |
Boolean |
Het rapport wordt per e-mail naar de gebruiker verstuurd als de waarde "true" is. |
fileType |
string |
Het bestandstype waarin u het rapport wilt ontvangen. Opties: "Excel" of "JSON" |
startYear |
integer |
Het jaar waarin u wilt beginnen. |
startMonth |
integer |
De maand waarin u wilt beginnen. (Maanden worden geteld vanaf 1, waarbij januari 1 is en december 12.) |
endYear |
integer |
Het jaar waarin u wilt eindigen. |
endMonth |
integer |
De maand waarin u wilt eindigen. (Maanden worden geteld vanaf 1, waarbij januari 1 is en december 12.) |
Voorbeeld-JSON-gegevens:
{"authenticationToken": "1126c18a-ec75-4a11-8ccc-566146f94tcc","subAccountId": "21a6a8d8-a609-4d60-ab21-9eca9013bb65","terms":"[{\"termId\":\"055e8635-c857-4f13-8b0f-63de5cb66aa1\",\"name\":\"Fall Term\"}]","email": "mathew.tyler@yuja.com",
"shouldEmail": true,"fileType": "Excel","startYear": 2022,"startMonth": 4,"endYear": 2023,"endMonth": 5}
4.2.3 - GET /content/exportContentReportData
Downloadt een inhoudsrapport voor de gekoppelde instelling, met de optie om te filteren op subaccounts en perioden waartoe u toegang hebt.
ExampleURL: https://panorama.yuja.com/api/content/exportContentReportData
Parameters:
Naam |
Type |
Beschrijving |
|---|---|---|
authenticationToken |
string |
Het authenticatietoken van de gebruiker. Wordt gebruikt om het verzoek te authenticeren. |
subAccountId |
string |
De subaccount-ID waarop u het rapport wilt filteren. Optioneel. |
termId |
string |
De periode-ID waarop u het rapport wilt filteren. Optioneel. |
string |
Het e-mailadres dat het rapport ontvangt. |
|
shouldEmail |
Boolean |
Het rapport wordt per e-mail naar de gebruiker verstuurd als de waarde "true" is. |
fileType |
string |
Het bestandstype waarin u het rapport wilt ontvangen. Opties: "Excel" of "JSON" |
startYear |
integer |
Het jaar waarin u wilt beginnen. |
startMonth |
integer |
De maand waarin u wilt beginnen. (Maanden worden geteld vanaf 1, waarbij januari 1 is en december 12.) |
endYear |
integer |
Het jaar waarin u wilt eindigen. |
endMonth |
integer |
De maand waarin u wilt eindigen. (Maanden worden geteld vanaf 1, waarbij januari 1 is en december 12.) |
Voorbeeld-JSON-gegevens:
{"authenticationToken": "1126c18a-ec75-4a11-8ccc-566146f94tcc","subAccountId": "21a6a8d8-a609-4d60-ab21-9eca9013bb65","termId": "60450295d546b0b925a2a7c4","email": "mathew.tyler@yuja.com","shouldEmail": true,"fileType": "Excel","startYear": 2022,"startMonth": 4,"endYear": 2023,"endMonth": 5}
4.2.4 - GET /issue/exportIssuesReport
Download het rapport met problemen voor de gekoppelde instelling. Het kan worden gefilterd op subaccounts en periodes waartoe u toegang hebt.
Voorbeeld-URL: https://panorama.yuja.com/api/issue/exportIssuesReport
Parameters:
Naam |
Type |
Beschrijving |
|---|---|---|
authenticationToken |
string |
Het authenticatietoken van de gebruiker. Wordt gebruikt om het verzoek te authenticeren. |
subAccountId |
string |
De ID van het subaccount waarop u het rapport wilt filteren. Optioneel. |
termId |
string |
De ID van de periode waarop u het rapport wilt filteren. Optioneel. |
string |
Het e-mailadres dat het rapport ontvangt. |
|
fileType |
string |
Het bestandstype waarin u het rapport wilt ontvangen. Opties: "Excel" of "JSON" |
startYear |
integer |
Het jaar waarmee u wilt beginnen. |
startMonth |
integer |
De maand waarmee u wilt beginnen. (Maanden worden geteld vanaf 1, waarbij januari 1 is en december 12.) |
endYear |
integer |
Het jaar waarin u wilt eindigen. |
endMonth |
integer |
De maand waarin u wilt eindigen. (Maanden worden geteld vanaf 1, waarbij januari 1 is en december 12.) |
Voorbeeld-JSON-gegevens:
{"authenticationToken": "1126c18a-ec75-4a11-8ccc-566146f94tcc","subAccountId": "21a6a8d8-a609-4d60-ab21-9eca9013bb65","termId": "60450295d546b0b925a2a7c4","email": "mathew.tyler@yuja.com","fileType": "Excel","startYear": 2022,"startMonth": 4,"endYear": 2023,"endMonth": 5}
5 - Overzicht van de cursusmodel-API
Het cursusmodel haalt cursussen en cursusrapporten op.
5.1 - Kern van het cursusmodel
Variabele |
Type |
Beschrijving |
|---|---|---|
contextId |
string |
De cursus-ID die uw LMS voor de cursus heeft gegenereerd. |
name |
string |
De naam van de cursus. |
5.2 - Hoofdendpoints van het cursusmodel
Methode |
Pad |
Beschrijving |
Vereist toegangsniveau |
|---|---|---|---|
GET |
/course/getPaginatedCourses |
Haalt een array op van cursussen binnen uw instelling waartoe u toegang hebt. |
Docent |
GET |
/document/getPaginatedCourseDocuments |
Haalt een array van documenten in een cursus op. |
Docent |
GET |
/course/exportCourseReport |
Downloadt een cursusrapport voor de gekoppelde cursus. |
Beheerder |
5.2.1 - GET /course/getPaginatedCourses
Haalt een array op van cursussen binnen uw instelling waartoe u toegang hebt.
Voorbeeld-URL: https://panorama.yuja.com/api/course/getPaginatedCourses
Parameters:
Naam |
Type |
Beschrijving |
|---|---|---|
authenticationToken |
string |
Het authenticatietoken van de gebruiker. Wordt gebruikt om het verzoek te authenticeren. |
page |
integer |
De pagina waarmee u wilt beginnen (begint bij 1). |
pageSize |
integer |
Het aantal records dat per pagina wordt ontvangen. |
Voorbeeld-JSON-gegevens:
{"authenticationToken": "1129c18a-eb75-4a11-8ccc-566646f94tcc","page": 2,"pageSize": 10}
5.2.2 - GET /document/getPaginatedCourseDocuments
Haalt een array van documenten in een cursus op.
Voorbeeld-URL: https://panorama.yuja.com/api/document/getPaginatedCourseDocuments
Parameters:
Naam |
Type |
Beschrijving |
|---|---|---|
authenticationToken |
string |
Uw authenticatietoken. Wordt gebruikt om het verzoek te authenticeren. |
contextId |
string |
De ID van de cursus waarvan u de documenten wilt opvragen. |
page |
integer |
De pagina waarmee u wilt beginnen (begint bij 1). |
pageSize |
integer |
Het aantal |
startYear |
integer |
Het jaar waarmee u wilt beginnen. |
startMonth |
integer |
De maand waarmee u wilt beginnen. (Maanden worden geteld vanaf 1, waarbij januari 1 is en december 12.) |
endYear |
integer |
Het jaar waarin u wilt eindigen. |
endMonth |
integer |
De maand waarin u wilt eindigen. (Maanden worden geteld vanaf 1, waarbij januari 1 is en december 12.) |
Voorbeeld-JSON-gegevens:
{"authenticationToken": "1129c18a-eb75-4a11-8ccc-566646f94tcc","contextId": "362","page": 10,"pageSize": 12"startYear": 2022,"startMonth": 4,"endYear": 2023,"endMonth": 5}
5.2.3 - GET /course/exportCourseReport
Download een cursusrapport voor de gekoppelde cursus.
Voorbeeld-URL: https://panorama.yuja.com/api/course/exportCourseReport
Parameters:
Naam |
Type |
Beschrijving |
|---|---|---|
authenticationToken |
string |
Het authenticatietoken van de gebruiker. Wordt gebruikt om het verzoek te authenticeren. |
contextId |
string |
De contextId van de cursus waarvan u het rapport wilt opvragen. |
string |
Het e-mailadres dat het rapport ontvangt. |
|
fileType |
string |
Het bestandstype waarin u het rapport wilt ontvangen. Opties: "Excel" of "JSON" |
startYear |
integer |
Het jaar waarmee u wilt beginnen. |
startMonth |
integer |
De maand waarmee u wilt beginnen. (Maanden worden geteld vanaf 1, waarbij januari 1 is en december 12.) |
endYear |
integer |
Het jaar waarin u wilt eindigen. |
endMonth |
integer |
De maand waarin u wilt eindigen. (Maanden worden geteld vanaf 1, waarbij januari 1 is en december 12.) |
Voorbeeld-JSON-gegevens:
{"authenticationToken": "1126c18a-ec75-4a11-8ccc-566146f94tcc","contextId": "202""email": "mathew.tyler@yuja.com","fileType": "Excel","startYear": 2022,"startMonth": 4,"endYear": 2023,"endMonth": 5}
6 - Documentmodel
Het documentmodel haalt informatie op over de status van documenten en hun alternatieve formaten.
6.1 - Hoofdendpoints van het documentmodel
Variabele |
Type |
Beschrijving |
|---|---|---|
accessibilityFormats |
Array<ConversionFormat> |
Een lijst met alternatieve formaten voor het document en de verwerkingsstatus van elk formaat. |
errorInterceptingDocument |
boolean |
Een boolean die aangeeft of er tijdens het ophalen van het document uit het LMS een fout is opgetreden. |
accessibilityReportInfo |
AccessibilityReportInfo |
Informatie over het toegankelijkheidsrapport van het document. Alleen beschikbaar met voldoende rechten. |
fileTypeNotSupported |
boolean |
Een boolean die aangeeft of het document een bestandstype heeft dat door Panorama wordt ondersteund. |
uploadedByStudent |
boolean |
Een boolean die aangeeft of het document door een student is geüpload. |
formatsHiddenFromStudents |
boolean |
Een boolean die aangeeft of de alternatieve formaten van het document voor studenten zijn verborgen. |
sourceDocumentUnavailable |
boolean |
Een boolean die aangeeft of er tijdens het ophalen van het bronbestand een fout is opgetreden. |
documentExpired |
boolean |
Een boolean die aangeeft of het document is verlopen. |
documentId |
string |
Een unieke institutionId die door het systeem wordt gegenereerd. |
documentFormat |
string |
Het extensietype van het document. |
documentName |
string |
De naam van het document. |
documentType |
String |
Het documenttype. |
documentSource |
string |
De bron van het document. |
6.2 - Hoofdendpoints van het documentmodel
Methode |
Pad |
Beschrijving |
Vereist toegangsniveau |
|---|---|---|---|
POST |
/api/documentDetails |
Haalt alle details van een opgegeven document op. |
Docent voor volledige toegang tot de API en student voor beperkte toegang. |
POST |
/api/generateFormat |
Genereert een alternatief formaat of toegankelijkheidsrapport voor een opgegeven document. |
Docent voor volledige toegang tot de API en student voor beperkte toegang. |
POST |
/api/downloadFormatUrl |
Haalt een download-URL op waarmee u een alternatief formaat voor een opgegeven document kunt downloaden. |
Docent voor volledige toegang tot de API en student voor beperkte toegang. |
6.2.1 - POST /api/documentDetails
Haalt alle details van een opgegeven document op.
Voorbeeld-URL: https://panorama-api.yuja.com/api/documentDetails
Parameters:
Naam |
Type |
Beschrijving |
|---|---|---|
identifierKey |
string |
De primaire identifierKey van uw instelling. |
extensionToken |
string |
Uw authenticatietoken. Wordt gebruikt om het verzoek te authenticeren. |
documentId |
string |
Een unieke ID van het document die kan worden opgehaald via de gepagineerde API voor cursusdocumenten in sectie 5.2.2. |
Voorbeeld-JSON-gegevens:
{
"identifierKey": "3b7a63c37e8c860bbb05bb550c5c1f0e817c2aad73056efd87bc848545a7f1j4",
"extensionToken": "1127c11a-eb75-4a41-8ccc-566646f94blc",
"documentId": "fcb6e196-b807-480d-9030-c29413e5bc2f1"
}
6.2.2 - POST /api/generateFormat
Genereert een alternatief formaat of toegankelijkheidsrapport voor een opgegeven document.
Voorbeeld-URL: https://panorama-api.yuja.com/api/generateFormat
Opmerking: De identifierKey en de extensionToken moeten worden ingesteld als queryparameters. De identifierKey moet worden ingesteld als Key en de extensionToken als Value.
Parameters:
Naam |
Type |
Beschrijving |
|---|---|---|
identifierKey |
string |
De primaire identifierKey van uw instelling. |
extensionToken |
string |
Uw authenticatietoken. Wordt gebruikt om het verzoek te authenticeren. |
documentId |
string |
De unieke ID van het document. |
type |
string |
Kies of u het document wilt genereren ("generate") of opnieuw wilt verwerken ("reprocess"). Geldige opties: generate: genereert het alternatieve formaat als dit niet beschikbaar is. reprocess: verwerkt het alternatieve formaat opnieuw als het al is gegenereerd. |
format |
string |
Het alternatieve formaat dat u wilt genereren of opnieuw wilt verwerken. Geldige opties: enhanced_html report source base immersive_html gradient_txt txt epub brf mp3 png math_latex math_txt math_mp3 ocr_pdf ocr_reconstructed_docx ocr_txt ocr_mp3 |
language |
string |
De taal waarin het alternatieve formaat wordt gegenereerd.
Als er geen vertaling nodig is, moet dit veld als volgt worden verzonden: default
Als een vertaling nodig is, stelt u dit veld in op de taalcode. voorbeelden: Voor Canadees Frans moet dit veld zijn: fr-ca
Voor Grieks moet dit veld zijn: el |
documentType |
string |
De documentbron die wordt geretourneerd door de API voor documentdetails in sectie 6.2.1. |
documentSource |
string |
De documentbron die wordt geretourneerd door de API voor documentdetails in sectie 6.2.1. |
Voorbeeld-JSON-gegevens:
{
"identifierKey": "3b7a63c37e8c860bbb05bb550c5c1f0e817c2aad73056efd87bc848545a7f1j4",
"extensionToken": "1127c11a-eb75-4a41-8ccc-566646f94blc",
"documentId": "fcb6e196-b807-480d-9030-c29413e5bc2f1",
"type": "generate",
"format": "pdf",
"language": "el",
"documentType": "discussion",
"documentSource": "lms"
}
6.2.3 - POST /api/downloadFormatUrl
Voorbeeld-URL: https://panorama-api.yuja.com/api/downloadFormatUrl
Opmerking: De geretourneerde download-URL is slechts één uur beschikbaar. Dit formaat moet eerder zijn gegenereerd en de status voltooid hebben wanneer u de status ervan bekijkt in de documentdetails.
Parameters:
Naam |
Type |
Beschrijving |
|---|---|---|
identifierKey |
string |
De primaire identifierKey van uw instelling. |
extensionToken |
string |
Uw authenticatietoken. Wordt gebruikt om het verzoek te authenticeren. |
documentId |
string |
De unieke ID van het document |
format |
string |
Het alternatieve formaat dat u wilt downloaden. Geldige opties: enhanced_html report source base immersive_html gradient_txt txt epub brf mp3 png math_latex math_txt math_mp3 ocr_pdf ocr_reconstructed_docx ocr_txt ocr_mp3 |
language |
string |
De taal waarin het alternatieve formaat wordt gegenereerd.
Als er geen vertaling nodig is, moet dit veld als volgt worden verzonden: default
Als een vertaling nodig is, stelt u dit veld in op de taalcode. voorbeeld: Voor Canadees Frans moet dit veld zijn: fr-ca
Voor Grieks moet dit veld zijn: el |
Voorbeeld-JSON-gegevens:
{
"identifierKey": "3b7a63c37e8c860bbb05bb550c5c1f0e817c2aad73056efd87bc848545a7f1j4", "extensionToken": "1127c11a-eb75-4a41-8ccc-566646f94blc",
"documentId": "fcb6e196-b807-480d-9030-c29413e5bc2f1",
"format": "pdf",
"language": "el"
}
7 - Een document uploaden naar DocHub
Gebruikers kunnen programmatisch een document uploaden naar DocHub, zonder het portaal van YuJa Panorama te gebruiken. Geüploade bestanden komen terecht in de hoofdmap van DocHub van de aanroepende gebruiker en worden automatisch in de wachtrij geplaatst voor het genereren van toegankelijke formaten.
7.1.1 - POST /getPresignedUploadUrl
Vraag een vooraf ondertekende upload-URL aan.
| Veld | Type | Vereist | Beschrijving |
|---|---|---|---|
| authenticationToken | string | Ja | Het authenticatietoken van de gebruiker. |
| filename | string | Ja | Basisbestandsnaam zonder extensie. |
| format | string | Ja | Bestandsextensie zonder de punt (zie de lijst met ondersteunde formaten). |
| fileSize | number | Ja | Bestandsgrootte in bytes. Moet ≤ 1 GB zijn. |
Voorbeeld-JSON-verzoek:
{
"authenticationToken": "<authenticationToken>",
"filename": "Course-Syllabus-Fall-2026",
"format": "pdf",
"fileSize": 2457600
}
Voorbeeld-JSON-antwoord:
{
"url": "https://<bucket>.s3.<region>.amazonaws.com/",
"fields": {
"key": "my-content/institutions/<institutionId>/documents/<documentId>/file.<format>",
"bucket": "<bucket>",
"X-Amz-Algorithm": "AWS4-HMAC-SHA256",
"X-Amz-Credential": "...",
"X-Amz-Date": "...",
"Policy": "<base64-policy>",
"X-Amz-Signature": "..."
},
"documentId": "<uuid>",
"fileKey": "my-content/institutions/<institutionId>/documents/<documentId>/file.<format>"
}
7.1.2 - Het bestand uploaden naar S3
Upload de bestandsblob naar S3: POST het bestand naar de "url" uit 7.1.1 in een verzoek van het type multipart/form-data. De volgorde van de formulieronderdelen is belangrijk; S3 vereist dat het bestand als laatste komt.
Opmerkingen:
- "url" en "fields" vormen een AWS presigned POST. U moet ze precies gebruiken zoals ze zijn geretourneerd.
- Bewaar "documentId" en "fileKey"; u geeft ze door aan "processFile" in 7.1.3.
- De presigned POST is één uur geldig.
Een geslaagde upload retourneert HTTP 204 met een lege body.
7.1.3 - POST /api/myContent/processFile
Met dit POST-verzoek geeft u YuJa Panorama de opdracht het bestand te verwerken.
| Veld | Type | Vereist | Beschrijving |
|---|---|---|---|
| authenticationToken | string | Ja | Het authenticatietoken van de gebruiker. |
| documentId | string | Ja | De documentId die in 7.1.1 is geretourneerd. |
| fileKey | string | Ja | De fileKey die in 7.1.1 is geretourneerd. |
Voorbeeld-JSON-verzoek:
{
"authenticationToken": "<authenticationToken>",
"documentId": "3f8c2a1e-7b4d-4e9a-9c61-2d5f8e0b7a34",
"fileKey": "my-content/institutions/<institutionId>/documents/3f8c2a1e-7b4d-4e9a-9c61-2d5f8e0b7a34/file.pdf"
}