Mostreremo un esempio utilizzando diverse richieste dell'API per creare un corso per temi.
A tal fine utilizziamo la richiesta POST content. Possiamo trovare la spiegazione e l'esempio della richiesta nella nostra documentazione dell'API nella sezione “CONTENT” -> “Content General” -> “Creare un content”.
POST https://www.apiclassonlive.com/api/v1/eyJhzI1NiJ9.eyjUzLjUz.../content
Questo metodo dovrà includere nel suo request body il titolo del corso e il tipo di corso. Nel nostro caso “Temas”:
{
"title": "Titolo di esempio",
"type": "Temas"
}
Se tutto è andato bene, questa richiesta restituisce un oggetto con la seguente struttura:
{
"ok": true,
"contentId": 33078
}
Questo oggetto conterrà la chiave “contentId”, che d'ora in poi identificherà il corso creato.
Ora che abbiamo creato il corso, aggiungeremo qualche tema. A tal fine possiamo vedere l'esempio nella nostra documentazione nella sezione “CONTENT” -> “Temas” -> “Aggiungere un tema a un corso”.
POST https://www.apiclassonlive.com/api/v1/ eyJhzI1NiJ9.eyjUzLjUz.../theme
Il relativo request body sarà il seguente:
{
"title":"Titolo del tema"
"description":"Descrizione del tema"
"contentId":33078 // contentId ricevuto dalla risposta precedente
"order":1 // Posizione che occuperà il tema creato
}
La risposta che riceveremo sarà la seguente:
{
"ok": true,
"themeId": 38
}
Dove “themeId” sarà l'identificatore che fa riferimento al nuovo tema creato.
Con questa richiesta potremo creare tanti temi quanti necessari per il nostro corso.
Un tema in sé non può memorizzare alcun tipo di risorsa per lo studente. I temi contengono moduli, i quali a loro volta contengono i contenuti che lo studente potrà visualizzare.
Il passo successivo è creare un modulo associato al tema. A tal fine possiamo vedere come creare un modulo nella sezione “CONTENT” -> “Temas” -> “Aggiungere un modulo a un tema” nella documentazione.
POST https://www.apiclassonlive.com/api/v1/eyJhzI1NiJ9.eyjUzLjUz.../theme/addModule
Dove il suo request body sarà simile al seguente:
{
"title":"Titolo del modulo"
"description":"Descrizione del nuovo modulo"
"themeId":38,
"contentId":33078
"order":1 // Posizione che occuperà il modulo all'interno del tema
}
Come risultato di questa richiesta riceveremo un oggetto con la seguente struttura:
{
"ok": true,
"moduleId": 60
}
Ora il nostro corso contiene un tema che a sua volta contiene un modulo.
Per aggiungere materiale a tale modulo al momento non ci sono metodi disponibili nella nostra API, quindi il processo di aggiunta del materiale dovrà essere effettuato dal nostro sito web.
Una volta preparato il nostro corso, il passo successivo sarà poter aggiungere gli studenti.
A tal fine disponiamo della richiesta content/student. Possiamo vedere più informazioni nella sezione dell'API “USUARIOS” -> “Applicant/alumno” -> “Aggiungere uno studente a un content”.
POST https://www.apiclassonlive.com/api/v1/eyJhzI1NiJ9.eyjUzLjUz.../content/student
Con il relativo request body:
{
"email": "[email protected]",
"contentId": 33078,
"name": "nome studente",
"themes": ["38"],
}
La chiave “themes” è opzionale. Serve solo quando si aggiungono studenti a un corso di tipo “Temas”. Serve per aggiungere uno studente a un corso per temi ma non si desidera che abbia accesso a tutti i temi del corso. Se questo è il caso si devono indicare all'interno dell'Array i “themeId” ai quali si desidera aggiungere lo studente.
Altrimenti, se si desidera che lo studente acceda a tutti i temi non è necessario aggiungere tale chiave.
Se tutto è andato bene si riceve la seguente risposta:
{
"link": "https://subdomain.classonlive.com/sala-webinar/titulo-de-ejemplo?code=Xs9JH7T/neCiFL93TWAQfQ==", // Si riceve il link di accesso alla sala solo se il corso è Sessione unica o Sessione multipla
"name": "nome studente",
"email": "[email protected]",
"applicantId": 142829,
"ok": true,
"isNewUser": true,
"password": "8476235" // Si riceve solo se è un nuovo utente
}
Con questo metodo potremo aggiungere tutti gli studenti che desideriamo.
Ora riceveremo le risorse aggiunte in precedenza dal sito, in modo che lo studente del corso possa utilizzarle.
Poiché si tratta di un corso per temi dobbiamo dirigerci alla sezione “CONTENT RESOURCES” -> “Resource temas/módulos” -> “Ricevere le resources di un modulo”.
GET https://www.apiclassonlive.com/api/v1/eyJhzI1NiJ9.eyjUzLjUz.../theme/getmoduleresources/60
Riceveremo una risposta simile alla seguente:
"resources": [
{
"resourceType": "Video",
"title": "video nuovo",
"description": "Questa è la descrizione del video",
"resourceId": 285095
},
{
"resourceType": "Resource",
"title": "Titolo della risorsa",
"description": "Questa è la descrizione del documento",
"resourceId": 380443
},
{
"resourceType": "Session",
"resourceId": 614091,
"initOneDayDate": 1621404000000,
"initMidLongDate": null,
"endMidLongDate": null,
"theContentDuration": "d30m",
"theContentMethod": "Broadcast",
"theContentType": "One_Day",
"theAssignedExpert": "[email protected]"
},...
Qui compaiono tutte le risorse associate al modulo aggiunto come parametro nella richiesta. Con questo oggetto potremo elencare tali risorse sul nostro sito.
Se ora vogliamo inoltre fornire il link di accesso alla risorsa dovremo chiamare la seguente richiesta. Possiamo trovare maggiori dettagli nella documentazione nella sezione “CONTENT RESOURCES” -> “Resource temas/módulos” -> “Ricevere il link di una resource di un modulo”.
GET https://www.apiclassonlive.com/api/v1/eyJhzI1NiJ9.eyjUzLjUz.../content/getmoduleresourcelink/Resource/380443
Questa richiesta è composta da due parametri. “Resource” è il “resourceType” ricevuto dalla richiesta descritta in precedenza. In questo caso tipo “Resource” e 380443, l'identificatore della resource ricevuto anch'esso dalla richiesta precedente.
La risposta che riceveremo avrà la seguente struttura:
{
"ok": true,
"link": "https://www.example.com/archivo.pdf"
}
Con questo, terminiamo l'esempio di come creare un corso di tipo temi, aggiungere temi e moduli all'interno di ciascun tema e infine mostrare le risorse di un modulo affinché gli studenti possano accedervi.