API Panorama – Centre d'aide YuJa

Authentification

Chaque appel d'API nécessite un jeton d'authentification, inclus dans le corps ou dans la chaîne de requête. Lorsque vous êtes connecté, vous pouvez trouver votre jeton en cliquant sur l'extension de navigateur Panorama. Dans votre requête, nommez ce paramètre authenticationToken.

Transport et encodage

L'API actuelle ne prend en charge que le format de données JSON. Il est recommandé de spécifier application/json comme en-tête accepté, mais ce n'est pas obligatoire.

URL de base de l'API

L'URL de base de l'API Panorama dépend de la zone dans laquelle votre établissement est enregistré. Si vous ne savez pas dans quelle zone se trouve votre établissement, veuillez contacter votre gestionnaire de compte. Conformément aux protocoles de sécurité, seul l'accès https est autorisé.

Pour les modèles utilisateur, établissement, cours, session et sous-compte :

Zone des États-Unis : https://panorama.yuja.com/api

Zone canadienne : https://panorama-cz.yuja.com/api

Zone européenne : https://panorama-ez.yuja.com/api

Zone australienne : https://panorama-az.yuja.com/api

Pour les modèles de document :

Zone des États-Unis : https://panorama-api.yuja.com/

Zone canadienne : https://panorama-api-cz.yuja.com/

Zone européenne : https://panorama-api-ez.yuja.com/

Zone australienne : https://panorama-api-az.yuja.com/

Codes de réponse de l'API REST

Code d'état	Signification
200	OK
201	Créé
204	Aucun contenu
400	Requête incorrecte
401	Non autorisé
403	Interdit
404	Introuvable
500	Erreur interne du serveur
502	Passerelle incorrecte

Modèles

L'API Panorama est divisée en plusieurs modèles, chacun représentant une entité différente, comme les cours ou les documents. Les modèles ci-dessous peuvent ne pas inclure tous les champs disponibles et n'affichent que les champs principaux de chaque modèle.

1 - Aperçu de l'API du modèle utilisateur

Le modèle utilisateur représente toutes les personnes associées au jeton d'accès fourni ou faisant partie de l'établissement.

1.1 - Champs principaux du modèle utilisateur

Variable	Type	Description
userId	string	Un userId unique généré par le système.
lmsUserId	string	Le userId que votre LMS a généré pour l'utilisateur.
email	string	L'adresse courriel de l'utilisateur.
firstName	string	Le prénom de l'utilisateur.
lastName	string	Le nom de famille de l'utilisateur.
role	string	Le rôle système de l'utilisateur.
locked	boolean	Indique si le rôle système de cet utilisateur est verrouillé ou non.

1.2 - Principaux points de terminaison

Méthode	Chemin	Description	Niveau d'accès requis
GET	/user/getUser	Récupère l'utilisateur actuel associé au jeton d'accès fourni.	Étudiant
GET	/user/getPaginatedUsers	Récupère un tableau des utilisateurs de votre établissement.	Administrateur
POST	/user/updateUserInfo	Met à jour le prénom, le nom de famille et l'adresse courriel de l'utilisateur.	Administrateur

1.2.1 - GET /user/getUser

Récupère l'utilisateur actuel associé au jeton d'accès fourni.

Exemple d'URL : https://panorama.yuja.com/api/user/getUser

Paramètre :

Nom	Type	Description
authenticationToken	string	Le jeton d'authentification de l'utilisateur. Utilisé pour authentifier la requête.

Exemple de données JSON :

{

"authenticationToken": "1129c18a-eb75-4a11-8ccc-566646f94tvc"

}

1.2.2 - GET /user/getPaginatedUsers

Récupère un tableau des utilisateurs de votre établissement.

Exemple d'URL : https://panorama.yuja.com/api/user/getPaginatedUsers

Paramètres :

Nom	Type	Description
authenticationToken	string	Le jeton d'authentification de l'utilisateur. Utilisé pour authentifier la requête.
page	integer	Un userId unique généré par le système.
pageSize	integer	Le nombre d'enregistrements à recevoir sur chaque page.

Exemple de requête JSON :

{

    "authenticationToken": "1129c18a-eb75-4a11-8ccc-566646f94tcc",

    "page": 2,

    "pageSize": 10

}

1.2.3 - POST /user/updateUserInfo

Met à jour le prénom, le nom de famille et l'adresse courriel de l'utilisateur.

Exemple d'URL : https://panorama.yuja.com/api/user/updateUserInfo

Paramètres :

Nom	Type	Description
authenticationToken	string	Le jeton d'authentification de l'utilisateur. Utilisé pour authentifier la requête.
userId	string	Le userId unique de l'utilisateur à mettre à jour.
firstName	string	Le prénom de l'utilisateur.
lastName	string	Le nom de famille de l'utilisateur.
email	string	L'adresse courriel de l'utilisateur.

Exemple de requête JSON :

{

    "authenticationToken": "1129c18a-eb75-4a11-8ccc-566646f94tcc",

    "userId": "2ffdc6e2-b250-4c53-b706-d4e2856beaeb",

    "firstName": "Lauren",

"lastName": Barnes",

"email": "lauren.barnes@mail.utoronto.ca"

}

2 - Aperçu de l'API du modèle de sous-compte

Le modèle de sous-compte représente tous les sous-comptes accessibles à la personne qui utilise l'API.

2.1 - Champs principaux du modèle de sous-compte

Variable	Type	Description
subAccountId	string	Un subAccountId unique généré par le système.
parentSubAccountId	string	Un subAccountId unique généré par le système pour le sous-compte parent du subAccount.
lmsSubAccountId	string	Le subAccountId que votre LMS a généré pour le sous-compte.
lmsParentSubAccountId	string	Le subAccountId que votre LMS a généré pour le sous-compte parent du sous-compte.
name	string	Le nom du sous-compte.

2.2 - Principaux points de terminaison

Méthode	Chemin	Description	Niveau d'accès requis
GET	/subAccount/getPaginatedSubAccounts	Récupère une liste des sous-comptes de votre établissement auxquels vous avez accès.	Sous-administrateur

2.2.1 - GET /subAccount/getPaginatedSubAccounts

Récupère une liste des sous-comptes de votre établissement auxquels vous avez accès.

Exemple d'URL : https://panorama.yuja.com/api/subAccount/getPaginatedSubAccounts

Paramètres :

Nom	Type	Description
authenticationToken	string	Le jeton d'authentification de l'utilisateur. Utilisé pour authentifier la requête.
page	integer	La page de départ (commence à 1).
pageSize	integer	Le nombre d'enregistrements à recevoir sur chaque page.

Exemple de données JSON :

{

    "authenticationToken": "1129c18a-eb75-4a11-8ccc-566646f94tcc",

    "page": 2,

    "pageSize": 10

}

3 - Aperçu de l'API du modèle de session

Le modèle de session représente toutes les sessions accessibles à la personne qui utilise l'API.

3.1 - Champs principaux du modèle de session

Variable	Type	Description
termId	string	Un termId unique généré par le système.
lmsTermId	string	Le termId que votre LMS a généré pour la session.
name	string	Le nom du sous-compte.
start	Date	La date de début de la session.
end	Date	La date de fin de la session.

3.2 - Principaux points de terminaison du modèle de session

Méthode	Chemin	Description	Niveau d'accès requis
GET	/term/getPaginatedTerms	Récupère un tableau des sessions de votre établissement.	Enseignant

3.2.1 - GET /term/getPaginatedTerms

Exemple d'URL : https://panorama.yuja.com/api/term/getPaginatedTerms

Récupère un tableau des sessions de votre établissement.

Paramètres :

Nom	Type	Description
authenticationToken	string	Le jeton d'authentification de l'utilisateur. Utilisé pour authentifier la requête.
page	integer	La page de départ (commence à 1).
pageSize	integer	Le nombre d'enregistrements à recevoir sur chaque page.

Exemple de données JSON :

{

    "authenticationToken": "1129c18a-eb75-4a11-8ccc-566646f94tcc",

    "page": 2,

    "pageSize": 10

}

4 - Aperçu de l'API du modèle d'établissement

Le modèle d'établissement récupère les informations auxquelles les administrateurs et les sous-administrateurs ont accès, comme les rapports d'établissement, les rapports sur le contenu et les rapports sur les problèmes.

4.1 - Champs principaux du modèle d'établissement

Variable	Type	Description
institutionId	string	Un institutionId unique généré par le système.
lmsType	string	Le type de LMS associé à l'établissement (par exemple Canvas).
name	string	Le nom de l'établissement.
primaryIdentifierKey	string	Une clé d'identification unique générée par le système.
secondaryIdentifierKey	string	Une clé d'identification secondaire unique générée par le système.
consumerKey	string	Une clé unique générée par le système pour être utilisée avec LTI 1.1.
ltiSecret	string	Une clé unique générée par le système pour être utilisée avec LTI 1.1.
clientId	string	L'ID client associé à l'établissement. Utilisé pour LTI 1.3.
deploymentId	string	L'ID de déploiement associé à un déploiement LTI. Utilisé pour LTI 1.3.
iss	string	L'émetteur associé à l'établissement. Utilisé pour LTI 1.3.
OIDCEndpoint	string	Le point de terminaison OIDC de l'établissement. Utilisé pour LTI 1.3.
JWKSEndpoint	string	Le point de terminaison JWKS de l'établissement. Utilisé pour LTI 1.3.
domain	string	Le domaine de l'établissement.
lmsAPILink	string	Le point de terminaison d'API associé à l'établissement.
accessToken	string	Le jeton d'accès de l'établissement. Utilisé pour les requêtes d'API adressées à l'établissement.

4.2 - Principaux points de terminaison du modèle d'établissement

Méthode	Chemin	Description	Niveau d'accès requis
GET	/institution/getInstitutionInformation	Récupère les informations sur l'établissement associé à votre compte.	Administrateur
GET	/institution/exportInstitutionReport	Télécharge un rapport d'accessibilité pour l'établissement associé. Il peut être filtré par les sous-comptes et les sessions auxquels vous avez accès.	Sous-administrateur
GET	/content/exportContentReportData	Télécharge un rapport sur le contenu pour l'établissement associé. Il peut être filtré par les sous-comptes et les sessions auxquels vous avez accès.	Sous-administrateur
GET	/issue/exportIssuesReport	Télécharge le rapport sur les problèmes pour l'établissement associé. Il peut être filtré par les sous-comptes et les sessions auxquels vous avez accès.	Sous-administrateur

4.2.1 - GET /institution/getInstitutionInformation

Récupère les informations sur l'établissement associé à votre compte.

Exemple d'URL : https://panorama.yuja.com/api/institution/getInstitutionInformation

Paramètres :

Nom	Type	Description
authenticationToken	string	Le jeton d'authentification de l'utilisateur. Utilisé pour authentifier la requête.

Exemple de données JSON :

{

"authenticationToken": "1129c18a-eb75-4a11-8ccc-566646f94tcc"

}

4.2.2 - GET /institution/exportInstitutionReport

Envoie par courriel et télécharge le rapport d'accessibilité du LMS. Ce rapport peut être filtré par sous-comptes et par sessions, ce qui vous permet de consulter toutes les données pertinentes pour votre établissement et vos cours.

Exemple d'URL : https://panorama.yuja.com/api/institution/exportInstitutionReport

Paramètres :

Nom	Type	Description
authenticationToken	string	Le jeton d'authentification de l'utilisateur. Utilisé pour authentifier la requête.
subAccountId	string	L'ID du sous-compte par lequel vous souhaitez filtrer le rapport. Facultatif.
terms	array	L'ID de session et le nom de session par lesquels vous souhaitez filtrer le rapport. Facultatif.
email	string	L'adresse courriel qui recevra le rapport.
shouldEmail	Boolean	Le rapport sera envoyé par courriel à l'utilisateur si la valeur est définie sur "true".
fileType	string	Le type de fichier dans lequel vous souhaitez obtenir le rapport. Options : "Excel" ou "JSON"
startYear	integer	L'année à laquelle vous souhaitez commencer.
startMonth	integer	Le mois auquel vous souhaitez commencer. (Les mois sont comptés à partir de 1, janvier étant le mois 1 et décembre le mois 12.)
endYear	integer	L'année à laquelle vous souhaitez terminer.
endMonth	integer	Le mois auquel vous souhaitez terminer. (Les mois sont comptés à partir de 1, janvier étant le mois 1 et décembre le mois 12.)

Exemple de données JSON :

{

    "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

Télécharge un rapport sur le contenu pour l'établissement associé, avec la possibilité de filtrer par les sous-comptes et les sessions auxquels vous avez accès.

Exemple d'URL : https://panorama.yuja.com/api/content/exportContentReportData

Paramètres :

Nom	Type	Description
authenticationToken	string	Le jeton d'authentification de l'utilisateur. Utilisé pour authentifier la requête.
subAccountId	string	L'ID du sous-compte par lequel vous souhaitez filtrer le rapport. Facultatif.
termId	string	L'ID de session par lequel vous souhaitez filtrer le rapport. Facultatif.
email	string	L'adresse courriel qui recevra le rapport.
shouldEmail	Boolean	Le rapport sera envoyé par courriel à l'utilisateur si la valeur est définie sur "true".
fileType	string	Le type de fichier dans lequel vous souhaitez obtenir le rapport. Options : "Excel" ou "JSON"
startYear	integer	L'année à laquelle vous souhaitez commencer.
startMonth	integer	Le mois auquel vous souhaitez commencer. (Les mois sont comptés à partir de 1, janvier étant le mois 1 et décembre le mois 12.)
endYear	integer	L'année à laquelle vous souhaitez terminer.
endMonth	integer	Le mois auquel vous souhaitez terminer. (Les mois sont comptés à partir de 1, janvier étant le mois 1 et décembre le mois 12.)

Exemple de données JSON :

{

    "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

Télécharge le rapport sur les problèmes pour l'établissement associé. Il peut être filtré par les sous-comptes et les sessions auxquels vous avez accès.

Exemple d'URL : https://panorama.yuja.com/api/issue/exportIssuesReport

Paramètres :

Nom	Type	Description
authenticationToken	string	Le jeton d'authentification de l'utilisateur. Utilisé pour authentifier la requête.
subAccountId	string	L'ID du sous-compte par lequel vous souhaitez filtrer le rapport. Facultatif.
termId	string	L'ID de session par lequel vous souhaitez filtrer le rapport. Facultatif.
email	string	L'adresse courriel qui recevra le rapport.
fileType	string	Le type de fichier dans lequel vous souhaitez obtenir le rapport. Options : "Excel" ou "JSON"
startYear	integer	L'année à laquelle vous souhaitez commencer.
startMonth	integer	Le mois auquel vous souhaitez commencer. (Les mois sont comptés à partir de 1, janvier étant le mois 1 et décembre le mois 12.)
endYear	integer	L'année à laquelle vous souhaitez terminer.
endMonth	integer	Le mois auquel vous souhaitez terminer. (Les mois sont comptés à partir de 1, janvier étant le mois 1 et décembre le mois 12.)

Exemple de données JSON :

{

    "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 - Aperçu de l'API du modèle de cours

Le modèle de cours récupère les cours et les rapports de cours

5.1 - Champs principaux du modèle de cours

Variable	Type	Description
contextId	string	L'ID de cours que votre LMS a généré pour le cours.
name	string	Le nom du cours.

5.2 - Principaux points de terminaison du modèle de cours

Méthode	Chemin	Description	Niveau d'accès requis
GET	/course/getPaginatedCourses	Récupère un tableau des cours de votre établissement auxquels vous avez accès.	Enseignant
GET	/document/getPaginatedCourseDocuments	Récupère un tableau des documents d'un cours.	Enseignant
GET	/course/exportCourseReport	Télécharge un rapport de cours pour le cours associé.	Administrateur

5.2.1 - GET /course/getPaginatedCourses

Récupère un tableau des cours de votre établissement auxquels vous avez accès.

Exemple d'URL : https://panorama.yuja.com/api/course/getPaginatedCourses

Paramètres :

Nom	Type	Description
authenticationToken	string	Le jeton d'authentification de l'utilisateur. Utilisé pour authentifier la requête.
page	integer	La page de départ (commence à 1).
pageSize	integer	Le nombre d'enregistrements à recevoir sur chaque page.

Exemple de données JSON :

{

    "authenticationToken": "1129c18a-eb75-4a11-8ccc-566646f94tcc",

    "page": 2,

    "pageSize": 10

}

5.2.2 - GET /document/getPaginatedCourseDocuments

Récupère un tableau des documents d'un cours.

Exemple d'URL : https://panorama.yuja.com/api/document/getPaginatedCourseDocuments

Paramètres :

Nom	Type	Description
authenticationToken	string	Votre jeton d'authentification. Utilisé pour authentifier la requête.
contextId	string	L'ID du cours dont vous souhaitez obtenir les documents.
page	integer	La page de départ souhaitée (commence à 1).
pageSize	integer	Le nombre de
startYear	integer	L'année à laquelle vous souhaitez commencer.
startMonth	integer	Le mois auquel vous souhaitez commencer. (Les mois sont comptés à partir de 1, janvier étant le mois 1 et décembre le mois 12.)
endYear	integer	L'année à laquelle vous souhaitez terminer.
endMonth	integer	Le mois auquel vous souhaitez terminer. (Les mois sont comptés à partir de 1, janvier étant le mois 1 et décembre le mois 12.)

Exemple de données JSON :

{

    "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

Télécharge un rapport de cours pour le cours associé.

Exemple d'URL : https://panorama.yuja.com/api/course/exportCourseReport

Paramètres :

Nom	Type	Description
authenticationToken	string	Le jeton d'authentification de l'utilisateur. Utilisé pour authentifier la requête.
contextId	string	Le contextId du cours dont vous souhaitez obtenir le rapport.
email	string	L'adresse courriel qui recevra le rapport.
fileType	string	Le type de fichier dans lequel vous souhaitez obtenir le rapport. Options : "Excel" ou "JSON"
startYear	integer	L'année à laquelle vous souhaitez commencer.
startMonth	integer	Le mois auquel vous souhaitez commencer. (Les mois sont comptés à partir de 1, janvier étant le mois 1 et décembre le mois 12.)
endYear	integer	L'année à laquelle vous souhaitez terminer.
endMonth	integer	Le mois auquel vous souhaitez terminer. (Les mois sont comptés à partir de 1, janvier étant le mois 1 et décembre le mois 12.)

Exemple de données JSON :

{

"authenticationToken": "1126c18a-ec75-4a11-8ccc-566146f94tcc",

"contextId": "202"

"email": "mathew.tyler@yuja.com",

"fileType": "Excel",

"startYear": 2022,

"startMonth": 4,

"endYear": 2023,

"endMonth": 5

}

6 - Modèle de document

Le modèle de document récupère des informations indiquant l'état des documents et de leurs formats alternatifs.

6.1 - Principaux points de terminaison du modèle de document

Variable	Type	Description
accessibilityFormats	Array<ConversionFormat>	Une liste des formats alternatifs du document et de l'état de traitement dans lequel ils se trouvent.
errorInterceptingDocument	boolean	Un booléen indiquant si le document a ou non rencontré une erreur lors de sa récupération depuis le LMS.
accessibilityReportInfo	AccessibilityReportInfo	Informations relatives au rapport d'accessibilité du document. Disponible uniquement avec les autorisations suffisantes.
fileTypeNotSupported	boolean	Un booléen indiquant si le document est ou non d'un type de fichier pris en charge par Panorama.
uploadedByStudent	boolean	Un booléen indiquant si le document a été ou non téléversé par un étudiant.
formatsHiddenFromStudents	boolean	Un booléen indiquant si les formats alternatifs du document sont ou non masqués aux étudiants.
sourceDocumentUnavailable	boolean	Un booléen indiquant si le document a ou non rencontré une erreur lors de la récupération du fichier source.
documentExpired	boolean	Un booléen indiquant si le document a ou non expiré.
documentId	string	Un institutionId unique généré par le système.
documentFormat	string	Le type d'extension du document.
documentName	string	Le nom du document.
documentType	String	Le type de document.
documentSource	string	La source du document.

6.2 - Principaux points de terminaison du modèle de document

Méthode	Chemin	Description	Niveau d'accès requis
POST	/api/documentDetails	Récupère tous les détails d'un document spécifié.	Enseignant pour un accès complet à l'API et étudiant pour un accès limité.
POST	/api/generateFormat	Génère un format alternatif ou un rapport d'accessibilité pour un document spécifié.	Enseignant pour un accès complet à l'API et étudiant pour un accès limité.
POST	/api/downloadFormatUrl	Récupère une URL de téléchargement permettant de télécharger un format alternatif pour un document spécifié.	Enseignant pour un accès complet à l'API et étudiant pour un accès limité.

6.2.1 - POST /api/documentDetails

Récupère tous les détails d'un document spécifié.

Exemple d'URL : https://panorama-api.yuja.com/api/documentDetails

Paramètres :

Nom	Type	Description
identifierKey	string	La clé identifierKey principale de votre établissement.
extensionToken	string	Votre jeton d'authentification. Utilisé pour authentifier la requête.
documentId	string	Un ID unique du document, pouvant être récupéré à partir de l'API paginée des documents de cours décrite à la section 5.2.2.

Exemple de données JSON :

{
"identifierKey": "3b7a63c37e8c860bbb05bb550c5c1f0e817c2aad73056efd87bc848545a7f1j4",
"extensionToken": "1127c11a-eb75-4a41-8ccc-566646f94blc",
"documentId": "fcb6e196-b807-480d-9030-c29413e5bc2f1"
}

6.2.2 - POST /api/generateFormat

Génère un format alternatif ou un rapport d'accessibilité pour un document spécifié.

Exemple d'URL : https://panorama-api.yuja.com/api/generateFormat

Remarque : L'identifierKey et l'extensionToken doivent être définis comme Query Params. L'identifierKey doit être défini comme Key et l'extensionToken comme Value.

Paramètres :

Nom	Type	Description
identifierKey	string	La clé identifierKey principale de votre établissement.
extensionToken	string	Votre jeton d'authentification. Utilisé pour authentifier la requête.
documentId	string	L'ID unique du document.
type	string	Indiquez si vous souhaitez générer ("generate") ou retraiter ("reprocess") le document. Options valides : generate : Génère le format alternatif s'il n'est pas disponible. reprocess : Retraite le format alternatif s'il a déjà été généré.
format	string	Le format alternatif que vous souhaitez générer ou retraiter. Options valides : enhanced_html report source base pdf immersive_html gradient_txt txt epub brf mp3 png math_latex math_txt math_mp3 ocr_pdf ocr_reconstructed_docx ocr_reconstructed_pdf ocr_reconstructed_html ocr_txt ocr_mp3
language	string	La langue dans laquelle le format alternatif est généré. Si aucune traduction n'est nécessaire, ce champ doit être envoyé comme suit : default Si une traduction est nécessaire, définissez ce champ sur le code de langue. Exemples : Pour le français canadien, ce champ doit être : fr-ca Pour le grec, ce champ doit être : el
documentType	string	La source du document renvoyée par l'API des détails du document à la section 6.2.1.
documentSource	string	La source du document renvoyée par l'API des détails du document à la section 6.2.1.

Exemple de données JSON :

{
"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

Exemple d'URL : https://panorama-api.yuja.com/api/downloadFormatUrl

Remarque : L'URL de téléchargement renvoyée ne sera disponible que pendant une heure, et ce format doit avoir été généré au préalable et avoir le statut terminé lorsque vous consultez son statut dans les détails du document.

Paramètres :

Nom	Type	Description
identifierKey	string	La clé identifierKey principale de votre établissement.
extensionToken	string	Votre jeton d'authentification. Utilisé pour authentifier la requête.
documentId	string	L'ID unique du document
format	string	Le format alternatif que vous souhaitez télécharger. Options valides : enhanced_html report source base pdf immersive_html gradient_txt txt epub brf mp3 png math_latex math_txt math_mp3 ocr_pdf ocr_reconstructed_docx ocr_reconstructed_pdf ocr_reconstructed_html ocr_txt ocr_mp3
language	string	La langue dans laquelle le format alternatif est généré. Si aucune traduction n'est nécessaire, ce champ doit être envoyé comme suit : default Si une traduction est nécessaire, définissez ce champ sur le code de langue. Exemple : Pour le français canadien, ce champ doit être : fr-ca Pour le grec, ce champ doit être : el

Exemple de données JSON :

{
"identifierKey": "3b7a63c37e8c860bbb05bb550c5c1f0e817c2aad73056efd87bc848545a7f1j4", "extensionToken": "1127c11a-eb75-4a41-8ccc-566646f94blc",
"documentId": "fcb6e196-b807-480d-9030-c29413e5bc2f1",
"format": "pdf",
"language": "el"
}

Authentification

Transport et encodage

URL de base de l'API

Pour les modèles utilisateur, établissement, cours, session et sous-compte :

Pour les modèles de document :

Codes de réponse de l'API REST

Modèles

1 - Aperçu de l'API du modèle utilisateur

1.1 - Champs principaux du modèle utilisateur

1.2 - Principaux points de terminaison

1.2.1 - GET /user/getUser

1.2.2 - GET /user/getPaginatedUsers

1.2.3 - POST /user/updateUserInfo

2 - Aperçu de l'API du modèle de sous-compte

2.1 - Champs principaux du modèle de sous-compte

2.2 - Principaux points de terminaison

2.2.1 - GET /subAccount/getPaginatedSubAccounts

3 - Aperçu de l'API du modèle de session

3.1 - Champs principaux du modèle de session

3.2 - Principaux points de terminaison du modèle de session

3.2.1 - GET /term/getPaginatedTerms

4 - Aperçu de l'API du modèle d'établissement

4.1 - Champs principaux du modèle d'établissement

4.2 - Principaux points de terminaison du modèle d'établissement

4.2.1 - GET /institution/getInstitutionInformation

4.2.2 - GET /institution/exportInstitutionReport

4.2.3 - GET /content/exportContentReportData

4.2.4 - GET /issue/exportIssuesReport

5 - Aperçu de l'API du modèle de cours

5.1 - Champs principaux du modèle de cours

5.2 - Principaux points de terminaison du modèle de cours

5.2.1 - GET /course/getPaginatedCourses

5.2.2 - GET /document/getPaginatedCourseDocuments

5.2.3 - GET /course/exportCourseReport

6 - Modèle de document

6.1 - Principaux points de terminaison du modèle de document

6.2 - Principaux points de terminaison du modèle de document

6.2.1 - POST /api/documentDetails

6.2.2 - POST /api/generateFormat

6.2.3 - POST /api/downloadFormatUrl

Articles associés