Plataforma para dar clases, cursos y videoconferencias online

API ClassOnlive

Si deseas usar la API de classonlive, vas a necesitar un TOKEN
Para conseguir el token, navega a tu panel de control de classonlive.com, ve a la sección de integraciones y haz click en la pestaña de API. Una vez allí deberás registrar la IP desde dónde se van a hacer las peticiones. A la ip se le asociará un token parecido a: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJjbGFzc29ubGl2ZSIsI.mRhdGEiOiJ7XC Debes cambiar la parte de {TOKEN} en las rutas, con el token asociado a tu IP. Sólo vas a poder hacer peticiones desde la ip que has registrado.
Esta api esta diseñada para crear webinars / conferencias en vivo / clases en directo. Estas clases en esta documentación serán llamadas como “content”.
Esta api no funciona con cursos modulares o de pack.

Content

Content General

ContentObject es el objeto que se devuelve al lanzar alguna petición de esta sección. Este objeto muestra información detallada sobre el curso en cuestión. Dependiendo de la petición el objeto puede mostrar mas o menos campos. En el apartado “Response Body” de cada petición se puede ver un ejemplo detallado de los campos que devuelve dicha petición.

Content General Object

Attributes

contentId
numberRequired
Identificador usado para borrar/editar el content
title
stringRequired
Titulo/nombre del content
teacher
stringRequired
Email del profesor
type
objectRequired
Devuelve un String con el tipo de videoconferencia a crear
Expand attributesClose attributes
- Broadcast
  string
  1 profesor, hasta 150 asistentes
- Many_to_Many
  string
  1 profesor, hasta 9 asistentes con audio/vídeo
- One_to_One
  string
  1 profesor, 1 asistente con audio/vídeo
oneDayDate
stringOptional
Date transformado a String con la fecha de la única sesión en directo, vacío si el content es de tipo contentDay
multipleDayFromDate
stringOptional
Date transformado a String con la fecha de inicio del curso, vacío si el content es de sólo un día
multipleDayToDate
stringOptional
Date transformado a String con la fecha de final del curso, vacío si el content es de un solo día
particularInitDate
stringOptional
Date transformado a String con la fecha de inicio del curso particular, vacío si el content es de un solo día
particularEndDate
stringOptional
Date transformado a String con la fecha de final del curso particular, vacío si el content es de un solo día
contentType
objectRequired
Devuelve un String con el tipo de content creado
Expand attributesClose attributes
- oneDay
  string
  Content con una sesión en directo de 1 día
- multipleDay
  string
  Content con varias sesiones en directo en diferentes días
- particular
  string
  Content del tipo clase particular

Crear un content

Url Parameters

token
string

Attributes

title
stringRequired
Example: Título de ejemplo
Título del curso
type
stringRequired
Example: Temas
'Medida','Modular','Temas','Particular','Pack' Tipo de curso.

Definition

POST https://www.apiclassonlive.com/api/v1/{token}/content

Request

Request Headers

Content-Type: application/json

Request Body

{
    "title": "Titulo de ejemplo",
    "type": "Temas"
}

Example Request

curl --request POST \
  --url https://www.apiclassonlive.com/api/v1/{token}/content \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "ok": true,
    "contentId": 33078
}

Editar un content

Url Parameters

token
string
contentId
string

Attributes

title
stringRequired
Example: Título de ejemplo
Título del curso
type
stringRequired
Example: Temas
'Medida','Temas','Particular','Pack' Tipo de curso.

Definition

PUT https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}

Request

Request Headers

Content-Type: application/json

Request Body

{
    "title": "Titulo de ejemplo",
    "type": "Temas"
}

Example Request

curl --request PUT \
  --url https://www.apiclassonlive.com/api/v1/{token}/content/{contentid} \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "ok": true,
    "contentId": 33078
}

Lista todos los contents

Url Parameters

token
string

Definition

GET https://www.apiclassonlive.com/api/v1/{token}/content

Request

Example Request

curl --request GET \
  --url https://www.apiclassonlive.com/api/v1/{token}/content

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "contentList": [
    {
        "contentId": 32957,
        "title": "Ejemplo curso un día",
        "teacher": "[email protected]",
        "oneDayDate": "2020-10-28T22:12:00.000Z",
        "multipleDayFromDate": null,
        "multipleDayToDate": null,
        "type": "Broadcast",
        "particularInitDate": null,
        "particularEndDate": null,
        "contentType": "oneDay"
    },
    {
        "contentId": 32956,
        "title": "Ejemplo curso multisesión",
        "teacher": "[email protected]",
        "oneDayDate": null,
        "multipleDayFromDate": "2020-07-23T22:00:00.000Z",
        "multipleDayToDate": "2020-08-24T22:00:00.000Z",
        "type": "Broadcast",
        "particularInitDate": null,
        "particularEndDate": null,
        "contentType": "multipleDay"
    },
    {
        "contentId": 32953,
        "title": "Ejemplo curso particular",
        "teacher": null,
        "oneDayDate": null,
        "multipleDayFromDate": null,
        "multipleDayToDate": null,
        "type": "Broadcast",
        "particularInitDate": null,
        "particularEndDate": null,
        "contentType": "particular"
    }
],
"ok": true
}

Pedir datos de un content

Url Parameters

contentId
string
token
string

Definition

GET https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}

Request

Example Request

curl --request GET \
  --url https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}

Response 200

Response Headers

Content-Type: application/json

Response Body

//si es de sesión única
{
    "content": {
        "contentId": 32960,
        "title": "título curso única sesión",
        "teacher": "[email protected]",
        "oneDayDate": "2020-10-28T22:12:00.000Z",
        "durartion": "d30m",
        "type": "Broadcast"
    },
    "ok": true
}
//si es multisesión
{
    "content": {
        "contentId": 32962,
        "title": "título curso multisesión",
        "teacher": "[email protected]",
        "multipleDayFromDate": "2020-07-23T22:00:00.000Z",
        "multipleDayToDate": "2020-08-24T22:00:00.000Z",
        "type": "Broadcast",
        "dates": [
            "2020-08-20T05:30:00.000Z",
            "2020-08-13T05:30:00.000Z",
            "2020-08-06T05:30:00.000Z",
            ...
        ]
    },
    "ok": true
}
//si es particular
{
    "content": {
        "contentId": 32953,
        "title": "título de curso particular",
        "startDate": null,
        "endDate": null,
        "type": "Broadcast",
        "contentType": "Particular"
    },
    "ok": true
}

borrar content

Url Parameters

contentId
string
token
string

Definition

DELETE https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}

Request

Example Request

curl --request DELETE \
  --url https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}

Response 200

Response Headers

Content-Type: application/json

Response Body

{
"ok": true
}

Cambiar el profesor a un content (multisesión o sesión única)

Url Parameters

contentId
string
token
string

Attributes

teacher
stringRequired
Example: [email protected]
Email del profesor

Definition

PUT https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}/teacher

Request

Request Headers

Content-Type: application/json

Request Body

{
    "teacher": "[email protected]"
}

Example Request

curl --request PUT \
  --url https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}/teacher \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "ok": true
}

Buscar content por título

Url Parameters

search
string
token
string

Definition

GET https://www.apiclassonlive.com/api/v1/{token}/content/search/{search}

Request

Example Request

curl --request GET \
  --url https://www.apiclassonlive.com/api/v1/{token}/content/search/{search}

Response 200

Response Headers

Content-Type: application/json

Response Body

{
"contentList": [
    {
        "contentId": 32957,
        "title": "Ejemplo curso un día",
        "teacher": "[email protected]",
        "oneDayDate": "2020-10-28T22:12:00.000Z",
        "multipleDayFromDate": null,
        "multipleDayToDate": null,
        "type": "Broadcast",
        "particularInitDate": null,
        "particularEndDate": null,
        "contentType": "oneDay"
    },
    {
        "contentId": 32956,
        "title": "Ejemplo curso multisesión",
        "teacher": "[email protected]",
        "oneDayDate": null,
        "multipleDayFromDate": "2020-07-23T22:00:00.000Z",
        "multipleDayToDate": "2020-08-24T22:00:00.000Z",
        "type": "Broadcast",
        "particularInitDate": null,
        "particularEndDate": null,
        "contentType": "multipleDay"
    },
    {
        "contentId": 32953,
        "title": "Ejemplo curso particular",
        "teacher": null,
        "oneDayDate": null,
        "multipleDayFromDate": null,
        "multipleDayToDate": null,
        "type": "Broadcast",
        "particularInitDate": null,
        "particularEndDate": null,
        "contentType": "particular"
    }
],
"ok": true
}

Modificar el título de un content

Url Parameters

contentId
string
token
string

Attributes

title
stringRequired
Example: Título de ejemplo
Título del curso

Definition

PUT https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}/title

Request

Request Headers

Content-Type: application/json

Request Body

{
    "title": "nuevo título"
}

Example Request

curl --request PUT \
  --url https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}/title \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "ok": true
}

Content Sesión Única

ContentSingleSessionObject es el objeto que se devuelve al lanzar alguna petición de esta sección. Este objeto muestra información detallada sobre el curso en cuestión. Dependiendo de la petición el objeto puede mostrar mas o menos campos. En el apartado “Response Body” de cada petición se puede ver un ejemplo detallado de los campos que devuelve dicha petición.

Content Sesión Única Object

Attributes

contentId
numberRequired
Identificador usado para borrar/editar el content
teacherLink
objectRequired
Objecto con enlace a la sala de videoconferencia
Expand attributesClose attributes
- ok
  booleanRequired
  Devuelve true si no se ha producido ningún error al crear la sesión, de lo contrario devuelve false
- link
  stringRequired
  Enalce a la sala de videoconferencia
- name
  stringRequired
  Nombre del profesor
- teacher
  stringRequired
  Email del profesor
ok
booleanRequired
Devuelve true si no se ha producido ningún error, de lo contrario devuelve false

Crear un content de sesión única

Url Parameters

token
string

Attributes

title
stringRequired
Example: Título de ejemplo
Título del curso
type
stringRequired
Example: Broadcast
'Broadcast' 1 profesor, hasta 150 asistentes, 'Many_to_Many' 1 profesor, hasta 9 asistentes con audio/video, 'One_to_One' 1 profesor, 1 asistente con audio/video
duration
stringRequired
Example: d30m
'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas
session
string
Example: 2020
10-28T22:12:00.000Z (string, required) - Fecha con fromato yyyy-MM-dd'T'HH:mm:ss.SSS'Z', tambien acepta fechas en millisegundos desde 1970 ej: 1573035966995
teacher
stringRequired
Example: [email protected]
Email del profesor

Definition

POST https://www.apiclassonlive.com/api/v1/{token}/content/oneDay

Request

Request Headers

Content-Type: application/json

Request Body

{
    "title": "Titulo de ejemplo",
    "session": "2020-10-28T22:12:00.000Z",
    "teacher": "[email protected]",
    "type": "Broadcast",
    "duration": "d30m"
}

Example Request

curl --request POST \
  --url https://www.apiclassonlive.com/api/v1/{token}/content/oneDay \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "contentId": 32960,
    "teacherLink": {
        "link": "https://subdomain.classonlive.com/sala-webinar/titulo-de-ejemplo?code=ye4ll60UOoahUykx/ZhY9A==",
        "name": "teacher name",
        "email": "[email protected]",
        "ok": true
    },
    "ok": true
}

Cambiar la sesión de un content de sesión única

Url Parameters

contentId
string
token
string

Attributes

duration
stringRequired
Example: d30m
'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas
date
string
Example: 2020
10-28T22:12:00.000Z (string, required) - Fecha con fromato yyyy-MM-dd'T'HH:mm:ss.SSS'Z', tambien acepta fechas en millisegundos desde 1970 ej: 1573035966995

Definition

PUT https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}/session

Request

Request Headers

Content-Type: application/json

Request Body

{
    "date": "2020-10-28T22:12:00.000Z",
    "duration": "d30m"
}

Example Request

curl --request PUT \
  --url https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}/session \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "ok": true
}

Content Sesión Múltiple

Content Sesión Multiple Object es el objeto que se devuelve al lanzar alguna petición de esta sección. Este objeto muestra información detallada sobre el curso en cuestión. Dependiendo de la petición el objeto puede mostrar mas o menos campos. En el apartado “Response Body” de cada petición se puede ver un ejemplo detallado de los campos que devuelve dicha petición.

Content Sesión Múltiple Object

Attributes

contentId
numberRequired
Example: 32966
Identificador del content sesión múltiple
ok
booleanRequired
Devuelve true si no se ha producido ningún error al crear la sesión múltiple, de lo contrario devuelve false

Crear un content de sesión múltiple

Url Parameters

contentId
string
token
string

Attributes

title
stringRequired
Example: Título de ejemplo
Título del curso
type
stringRequired
Example: Broadcast
'Broadcast' 1 profesor, hasta 150 asistentes, 'Many_to_Many' 1 profesor, hasta 9 asistentes con audio/video, 'One_to_One' 1 profesor, 1 asistente con audio/video
teacher
stringRequired
Example: [email protected]
Email del profesor
startDate
stringRequired
Example: 2019-11-20
Fecha en formato YYYY-MM-DD
endDate
stringRequired
Example: 2019-11-20
Fecha en formato YYYY-MM-DD
monday
object
Objeto con propiedades
Expand attributesClose attributes
- hour
  stringRequired
  hora en GMT con formato HH
- minutes
  stringRequired
  minutes (Sólo acepta 0, 15, 30, 45)
- duration
  stringRequired
  Sólo acepta: 'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas`
tuesday
object
Objeto con propiedades
Expand attributesClose attributes
- hour
  stringRequired
  hora en GMT con formato HH
- minutes
  stringRequired
  minutes (Sólo acepta 0, 15, 30, 45)
- duration
  stringRequired
  Sólo acepta: 'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas`
wednesday
object
Objeto con propiedades
Expand attributesClose attributes
- hour
  stringRequired
  hora en GMT con formato HH
- minutes
  stringRequired
  minutes (Sólo acepta 0, 15, 30, 45)
- duration
  stringRequired
  Sólo acepta: 'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas`
thursday
object
Objeto con propiedades
Expand attributesClose attributes
- hour
  stringRequired
  hora en GMT con formato HH
- minutes
  stringRequired
  minutes (Sólo acepta 0, 15, 30, 45)
- duration
  stringRequired
  Sólo acepta: 'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas`
friday
object
Objeto con propiedades
Expand attributesClose attributes
- hour
  stringRequired
  hora en GMT con formato HH
- minutes
  stringRequired
  minutes (Sólo acepta 0, 15, 30, 45)
- duration
  stringRequired
  Sólo acepta: 'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas`
saturday
object
Objeto con propiedades
Expand attributesClose attributes
- hour
  stringRequired
  hora en GMT con formato HH
- minutes
  stringRequired
  minutes (Sólo acepta 0, 15, 30, 45)
- duration
  stringRequired
  Sólo acepta: 'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas`
sunday
object
Objeto con propiedades
Expand attributesClose attributes
- hour
  stringRequired
  hora en GMT con formato HH
- minutes
  stringRequired
  minutes (Sólo acepta 0, 15, 30, 45)
- duration
  stringRequired
  Sólo acepta: 'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas`

Definition

POST https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}/multipleday

Request

Request Headers

Content-Type: application/json

Request Body

{
    "title": "Título de ejemplo",
    "startDate": "2020-10-28T22:12:00.000Z",
    "endDate": "2020-11-28T22:12:00.000Z",
    "type": "Broadcast",
    "teacher":"[email protected]",
    "wednesday": {
        "hour":"02",
        "minutes":"30",
        "duration":"d15h"
        },
    "tuesday": {
        "hour":"02",
        "minutes":"30",
        "duration":"d15h"
        }
}

Example Request

curl --request POST \
  --url https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}/multipleday \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "contentId": 32966,
    "ok": true
}

Cambiar la sesión de un content de sesión múltiple

Url Parameters

contentId
string
token
string

Attributes

title
stringRequired
Example: Título de ejemplo
Título del curso
type
stringRequired
Example: Broadcast
'Broadcast' 1 profesor, hasta 150 asistentes, 'Many_to_Many' 1 profesor, hasta 9 asistentes con audio/video, 'One_to_One' 1 profesor, 1 asistente con audio/video
teacher
stringRequired
Example: [email protected]
Email del profesor
startDate
stringRequired
Example: 2019-11-20
Fecha en formato YYYY-MM-DD
endDate
stringRequired
Example: 2019-11-20
Fecha en formato YYYY-MM-DD
monday
object
Objeto con propiedades
Expand attributesClose attributes
- hour
  stringRequired
  hora en GMT con formato HH
- minutes
  stringRequired
  minutes (Sólo acepta 0, 15, 30, 45)
- duration
  stringRequired
  Sólo acepta: 'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas`
tuesday
object
Objeto con propiedades
Expand attributesClose attributes
- hour
  stringRequired
  hora en GMT con formato HH
- minutes
  stringRequired
  minutes (Sólo acepta 0, 15, 30, 45)
- duration
  stringRequired
  Sólo acepta: 'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas`
wednesday
object
Objeto con propiedades
Expand attributesClose attributes
- hour
  stringRequired
  hora en GMT con formato HH
- minutes
  stringRequired
  minutes (Sólo acepta 0, 15, 30, 45)
- duration
  stringRequired
  Sólo acepta: 'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas`
thursday
object
Objeto con propiedades
Expand attributesClose attributes
- hour
  stringRequired
  hora en GMT con formato HH
- minutes
  stringRequired
  minutes (Sólo acepta 0, 15, 30, 45)
- duration
  stringRequired
  Sólo acepta: 'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas`
friday
object
Objeto con propiedades
Expand attributesClose attributes
- hour
  stringRequired
  hora en GMT con formato HH
- minutes
  stringRequired
  minutes (Sólo acepta 0, 15, 30, 45)
- duration
  stringRequired
  Sólo acepta: 'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas`
saturday
object
Objeto con propiedades
Expand attributesClose attributes
- hour
  stringRequired
  hora en GMT con formato HH
- minutes
  stringRequired
  minutes (Sólo acepta 0, 15, 30, 45)
- duration
  stringRequired
  Sólo acepta: 'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas`
sunday
object
Objeto con propiedades
Expand attributesClose attributes
- hour
  stringRequired
  hora en GMT con formato HH
- minutes
  stringRequired
  minutes (Sólo acepta 0, 15, 30, 45)
- duration
  stringRequired
  Sólo acepta: 'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas`

Definition

PUT https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}/multipleday

Request

Request Headers

Content-Type: application/json

Request Body

{
    "startDate": "2020-10-28T22:12:00.000Z",
    "endDate": "2020-11-28T22:12:00.000Z",
    "type": "Broadcast",
    "teacher":"[email protected]",
    "wednesday": {
        "hour":"02",
        "minutes":"30",
        "duration":"d15h"
        }
}

Example Request

curl --request PUT \
  --url https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}/multipleday \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "contentId": 32966,
    "ok": true
}

Pack

Content tipo pack es un content que engloba varios content.

Añadir contents a un pack

Url Parameters

token
string
contentId
string

Attributes

selectedContents
arrayRequired
array de numeros, cada número debe corresponder a un contentId de un content tipo 'Medida' o 'Drip'

Definition

POST https://www.apiclassonlive.com/api/v1/{token}/content/{contentId}/packContents

Request

Request Headers

Content-Type: application/json

Request Body

{
   "selectedContents": [33057, 33054]
}

Example Request

curl --request POST \
  --url https://www.apiclassonlive.com/api/v1/{token}/content/{contentId}/packContents \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    ok: true
}

Particular

ParticularObject es el objeto que se devuelve al lanzar alguna petición de esta sección. Este objeto muestra información detallada sobre el curso en cuestión. Dependiendo de la petición el objeto puede mostrar mas o menos campos. En el apartado “Response Body” de cada petición se puede ver un ejemplo detallado de los campos que devuelve dicha petición.

Particular Object

Attributes

contentId
numberRequired
Identificador usado para borrar/editar el content
sessions
objectRequired
Array de objetos sesión
Expand attributesClose attributes
- sessionId
  numberRequired
  identificador de la sesión
- teacher
  stringRequired
  Email del profesor
- date
  stringRequired
  Fecha de la sesión
- teacherLink
  stringRequired
  Link de acceso a la sesión para el profesor
- applicants
  objectRequired
  Array de objetos alumno
  Expand attributesClose attributes
  - applicantId
    numberRequired
    identificador del alumno
  - email
    stringRequired
    Email del alumno
  - name
    stringRequired
    Nombre del alumno
  - link
    stringRequired
    Link de acceso a la sesión para el alumno
ok
booleanRequired
Devuelve true si no se ha producido ningún error, de lo contrario devuelve false
type
objectRequired
Devuelve un String con el tipo de videoconferencia a crear
Expand attributesClose attributes
- Broadcast
  string
  1 profesor, hasta 150 asistentes
- Many_to_Many
  string
  1 profesor, hasta 9 asistentes con audio/vídeo
- One_to_One
  string
  1 profesor, 1 asistente con audio/vídeo

Crear un content particular

Url Parameters

token
string

Attributes

title
stringRequired
Example: Título de ejemplo
Título del curso
type
stringRequired
Example: Broadcast
'Broadcast' 1 profesor, hasta 150 asistentes, 'Many_to_Many' 1 profesor, hasta 9 asistentes con audio/video, 'One_to_One' 1 profesor, 1 asistente con audio/video

Definition

POST https://www.apiclassonlive.com/api/v1/{token}/content/particular

Request

Request Headers

Content-Type: application/json

Request Body

{
    "title": "particular desde API",
    "type": "Broadcast"
}

Example Request

curl --request POST \
  --url https://www.apiclassonlive.com/api/v1/{token}/content/particular \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "ok": true,
    "contentId": 32961
}

Modificar un content particular

Url Parameters

contentId
string
token
string

Attributes

title
stringRequired
Example: Título de ejemplo
Título del curso
type
stringRequired
Example: Broadcast
'Broadcast' 1 profesor, hasta 150 asistentes, 'Many_to_Many' 1 profesor, hasta 9 asistentes con audio/video, 'One_to_One' 1 profesor, 1 asistente con audio/video

Definition

PUT https://www.apiclassonlive.com/api/v1/{token}/content/particular/{contentId}

Request

Request Headers

Content-Type: application/json

Request Body

{
    "title": "particular desde API",
    "type": "Broadcast"
}

Example Request

curl --request PUT \
  --url https://www.apiclassonlive.com/api/v1/{token}/content/particular/{contentId} \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "ok": true,
    "contentId": 32961
}

añadir/cambiar el calendario de un content particular

Url Parameters

contentId
string
token
string

Attributes

startDate
stringRequired
Example: 2019-11-20
Fecha en formato YYYY-MM-DD
endDate
stringRequired
Example: 2019-11-20
Fecha en formato YYYY-MM-DD
sessions
arrayRequired
Example: [object Object]
Cada objeto debe tener una propiedad teacher con el email del profesor y una propiedad por dia de la semana (al menos un día es requerido), con el nombre del día en ingles, con un array de las horas en formato HH:00 con la hora correspondiente a la zona horaria GMT

Definition

PUT https://www.apiclassonlive.com/api/v1/{token}/particular/{contentid}/calendar

Request

Request Headers

Content-Type: application/json

Request Body

{
    "startDate": "2019-11-20",
    "endDate": "2020-01-20",
    "sessions": [
        {
            "teacher":"[email protected]",
            "monday": ["12:00", "14:00"],
            "tuesday": ["13:00"]
        }
    ]
}

Example Request

curl --request PUT \
  --url https://www.apiclassonlive.com/api/v1/{token}/particular/{contentid}/calendar \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "contentId": "32951",
    "ok": true
}

Pedir el calendario de un content particular

Url Parameters

contentId
string
token
string

Definition

GET https://www.apiclassonlive.com/api/v1/{token}/particular/{contentid}/calendar

Request

Example Request

curl --request GET \
  --url https://www.apiclassonlive.com/api/v1/{token}/particular/{contentid}/calendar

Response 200

Response Headers

Content-Type: application/json

Response Body

    {
        "contentId": "32951",
        "sessions": [
            {
                "sessionId": 85262,
                "teacher": "[email protected]",
                "date": "2019-11-25T12:00:00.000Z",
                "teacherLink": "https://subdomain.classonlive.com/sala-personalizada/title-18?code=//TiEr+Mz1AYTxk1JwViRA==&claseParticularId=85262",
                "applicants": [
                    {
                        "applicantId": 142819,
                        "email": "[email protected]",
                        "name": "pepa",
                        "link": "https://subdomain.classonlive.com/sala-personalizada/title-18?code=goNzUM32KTAc/53SbBQhLA==&claseParticularId=85262"
                    },
                    {
                        "applicantId": 142826,
                        "email": "[email protected]",
                        "name": "pepa",
                        "link": "https://subdomain.classonlive.com/sala-personalizada/title-18?code=g8FK3/hKIHVHaAqRZWrjZA==&claseParticularId=85262"
                    }
                ]
            },
            {
                "sessionId": 85263,
                "teacher": "[email protected]",
                "date": "2019-11-25T14:00:00.000Z",
                "teacherLink": "https://subdomain.classonlive.com/sala-personalizada/title-18?code=//TiEr+Mz1AYTxk1JwViRA==&claseParticularId=85263",
                "applicants": [
                    {
                        "applicantId": 142826,
                        "email": "[email protected]",
                        "name": "pepa",
                        "link": "https://subdomain.classonlive.com/sala-personalizada/title-18?code=g8FK3/hKIHVHaAqRZWrjZA==&claseParticularId=85263"
                    }
                ]
            }
        ],
        "ok": true,
        "type": "One_to_One"
    }

Temas

ThemeObject es el objeto que se devuelve al lanzar alguna petición solicitando un tema.

Temas Object

Attributes

themeId
numberRequired
Identificador usado para borrar/editar el tema
title
stringRequired
Titulo/nombre del tema
description
stringOptional
Descripción del tema

Añadir un tema a un curso

Url Parameters

token
string

Attributes

contentId
numberRequired
Identificador del content
title
stringRequired
Titulo/nombre del tema
description
stringRequired
Descrtipción del tema
order
numberRequired
Número utilizado para ordenar los temas.
themeId
number
Identificador de tema en caso de querer editar un tema. Para crear un tema nuevo dejar vacío.

Definition

POST https://www.apiclassonlive.com/api/v1/{token}/theme

Request

Request Headers

Content-Type: application/json

Request Body

{
    "title":"Título del tema"
    "description":"Descripción del tema"
    "contentId":33079
    "order":1
}

Example Request

curl --request POST \
  --url https://www.apiclassonlive.com/api/v1/{token}/theme \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "ok": true,
    "themeId": 38
}

Añadir un módulo a un tema

Url Parameters

token
string

Attributes

contentId
numberRequired
Identificador del content
title
stringRequired
Titulo/nombre del módulo
description
stringRequired
Descrtipción del módulo
order
numberRequired
Número utilizado para ordenar los temas.
themeId
numberRequired
Identificador del tema en el que se va a añadir el módulo.
moduleId
number
Identificador de módulo en caso de querer editar un módulo. Para crear un módulo nuevo dejar vacío.

Definition

POST https://www.apiclassonlive.com/api/v1/{token}/theme/addModule

Request

Request Headers

Content-Type: application/json

Request Body

{
    "title":"Título del módulo"
    "description":"Descripción del módulo"
    "contentId":33079,
    "themeId": 38,
    "order":1
}

Example Request

curl --request POST \
  --url https://www.apiclassonlive.com/api/v1/{token}/theme/addModule \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "ok": true,
    "moduleId": 38
}

Añadir una sessión única a un módulo

Url Parameters

token
string

Attributes

type
stringRequired
Example: Broadcast
'Broadcast' 1 profesor, hasta 150 asistentes, 'Many_to_Many' 1 profesor, hasta 9 asistentes con audio/video, 'One_to_One' 1 profesor, 1 asistente con audio/video
duration
stringRequired
Example: d30m
'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas
startDay
string
Example: 2020
10-28T22:12:00.000Z (string, required) - Fecha con fromato yyyy-MM-dd'T'HH:mm:ss.SSS'Z', tambien acepta fechas en millisegundos desde 1970 ej: 1573035966995
teacher
stringRequired
Example: [email protected]
Email del profesor
moduleId
number
Identificador de módulo.

Definition

POST https://www.apiclassonlive.com/api/v1/{token}/theme/setOneDaySession

Request

Request Headers

Content-Type: application/json

Request Body

{
    "duration":"d15h",
    "moduleId":11789,
    "startDay":1622373300000,
    "teacher":"[email protected]",
    "type":"Broadcast"
}

Example Request

curl --request POST \
  --url https://www.apiclassonlive.com/api/v1/{token}/theme/setOneDaySession \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    ok: true,
    resourceId: 32425
}

Añadir una sessión única a un módulo

Url Parameters

token
string

Attributes

type
stringRequired
Example: Broadcast
'Broadcast' 1 profesor, hasta 150 asistentes, 'Many_to_Many' 1 profesor, hasta 9 asistentes con audio/video, 'One_to_One' 1 profesor, 1 asistente con audio/video
teacher
stringRequired
Example: [email protected]
Email del profesor
startDate
stringRequired
Example: 2019-11-20
Fecha en formato YYYY-MM-DD ó millisegundos desde 1970
endDate
stringRequired
Example: 2019-11-20
Fecha en formato YYYY-MM-DD ó millisegundos desde 1970
monday
object
Objeto con propiedades
Expand attributesClose attributes
- hour
  stringRequired
  hora en GMT con formato HH
- minutes
  stringRequired
  minutes (Sólo acepta 0, 15, 30, 45)
- duration
  stringRequired
  Sólo acepta: 'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas`
tuesday
object
Objeto con propiedades
Expand attributesClose attributes
- hour
  stringRequired
  hora en GMT con formato HH
- minutes
  stringRequired
  minutes (Sólo acepta 0, 15, 30, 45)
- duration
  stringRequired
  Sólo acepta: 'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas`
wednesday
object
Objeto con propiedades
Expand attributesClose attributes
- hour
  stringRequired
  hora en GMT con formato HH
- minutes
  stringRequired
  minutes (Sólo acepta 0, 15, 30, 45)
- duration
  stringRequired
  Sólo acepta: 'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas`
thursday
object
Objeto con propiedades
Expand attributesClose attributes
- hour
  stringRequired
  hora en GMT con formato HH
- minutes
  stringRequired
  minutes (Sólo acepta 0, 15, 30, 45)
- duration
  stringRequired
  Sólo acepta: 'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas`
friday
object
Objeto con propiedades
Expand attributesClose attributes
- hour
  stringRequired
  hora en GMT con formato HH
- minutes
  stringRequired
  minutes (Sólo acepta 0, 15, 30, 45)
- duration
  stringRequired
  Sólo acepta: 'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas`
saturday
object
Objeto con propiedades
Expand attributesClose attributes
- hour
  stringRequired
  hora en GMT con formato HH
- minutes
  stringRequired
  minutes (Sólo acepta 0, 15, 30, 45)
- duration
  stringRequired
  Sólo acepta: 'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas`
sunday
object
Objeto con propiedades
Expand attributesClose attributes
- hour
  stringRequired
  hora en GMT con formato HH
- minutes
  stringRequired
  minutes (Sólo acepta 0, 15, 30, 45)
- duration
  stringRequired
  Sólo acepta: 'd30m' 30 min, 'd1h' 1 hora, 'd15h' 1h 30m, 'd2h' 2 horas, 'd3h' 3 horas, 'd4h' 4 horas, 'd5h' 5 horas, 'd6h' 6 horas, 'd7h' 7 horas, 'd8h' 8 horas'
moduleId
number
Identificador de módulo.

Definition

POST https://www.apiclassonlive.com/api/v1/{token}/theme/setMultipleDaySession

Request

Request Headers

Content-Type: application/json

Request Body

{
    "moduleId":11788,
    "startDate":1621591200000,
    "teacher":"[email protected]",
    "endDate":1624096800000,
    "type":"Broadcast",
    "thursday": {"duration":"d5h", "minutes": "30", "hour": "11"},
    "tuesday": {"duration": "d6h", "minutes": "30", "hour": "14"}
}

Example Request

curl --request POST \
  --url https://www.apiclassonlive.com/api/v1/{token}/theme/setMultipleDaySession \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    ok: true,
    resourceId: 32425
}

Pedir los módulos de un tema

Url Parameters

token
string
themeId
string

Definition

GET https://www.apiclassonlive.com/api/v1/{token}/theme/getThemeModules/{themeId}

Request

Request Headers

Content-Type: application/json

Example Request

curl --request GET \
  --url https://www.apiclassonlive.com/api/v1/{token}/theme/getThemeModules/{themeId} \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "ok": true,
    "modules": {
        134: {
            moduleId: 134,
            title: "Título del módulo",
            description: "Descripción del módulo",
            order: 1
        },
        ...
    }
}

Pedir los contenidos de un módulo

Url Parameters

token
string
themeId
string

Attributes

email
stringRequired
Example: [email protected]
Email del profesor

Definition

GET https://www.apiclassonlive.com/api/v1/{token}/theme/getModule/{moduleId}

Request

Request Headers

Content-Type: application/json

Request Body

{
  "email": "[email protected]"
}

Example Request

curl --request GET \
  --url https://www.apiclassonlive.com/api/v1/{token}/theme/getModule/{moduleId} \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "ok": true,
    "module": [
        {
            'resourceType': 'Session',
            'resourceId': 324234,
            "initOneDayDate": null,
            "initMidLongDate": '2020-10-28T22:12:00.000Z',
            "endMidLongDate": '2020-10-28T22:12:00.000Z',
            "theContentDuration": 'd1h',
            "theContentMethod": 'Broadcast',
            "theContentType": 'Mid-Long',
            "theAssignedExpert": '[email protected]',
        },
        {
            'resourceType': 'Video'
            "resourceId": 2342,
            "title": 'título',
            "description": 'descripción'
        },
        {
            'resourceType': 'Resource',
            "resourceId": 34523,
            "title": 'título',
            "description": 'descripción'
        }
    ]
}

Content Resources

Resource general

Resource es el objeto que se devuelve al lanzar alguna petición de esta sección. Este objeto muestra información sobre el recurso en cuestión. En el apartado “Response Body” de cada petición se puede ver un ejemplo detallado de los campos que devuelve dicha petición.

Resource general Object

Attributes

resourceType
stringRequired
Tipo de recurso - ["Video","Resource",("Session" Solo si el content es de tipo temas)]
title
stringRequired
Titulo/nombre del recurso
description
stringRequired
Descripción del recurso
resourceId
numberRequired
Identificador del recurso

Recibir resources de un curso

Url Parameters

token
string
contentId
string

Definition

GET https://www.apiclassonlive.com/api/v1/{token}/content/getresources/{contentId}

Request

Example Request

curl --request GET \
  --url https://www.apiclassonlive.com/api/v1/{token}/content/getresources/{contentId}

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "courseTitle": "Titulo del curso",
    "external": null,
    "creator": 13653,
    "courseType": null,
    "own": [],
    "resources": [
        {
            "resourceType": "Video",
            "title": "vídeo nuevo",
            "description": "Esta es la descripción del vídeo",
            "resourceId": 285095
        },
        {
            "resourceType": "Resource",
            "title": "Título del recurso",
            "description": "Esta es la descripción del documento",
            "resourceId": 380443
        },...
    ],
    "contentIdentifier": "titulo-del-curo",
    "ok": true
}

Recibir el enlace de un resource

Esta petición devolverá un enlace de acceso al recurso en cuestión. El parámetro resourceType solo admite los String (“Video”, “Resource”).

Url Parameters

token
string
resourceType
string
resourceId
string

Definition

GET https://www.apiclassonlive.com/api/v1/{token}/content/getresourcelink/{resourceType}/{resourceId}

Request

Example Request

curl --request GET \
  --url https://www.apiclassonlive.com/api/v1/{token}/content/getresourcelink/{resourceType}/{resourceId}

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "ok": true,
    "link": "https://www.example.com/archivo.pdf"
}

Resource temas/módulos

Resource temas/módulos Object

Attributes

resourceType
stringRequired
Tipo de recurso - ["Video","Resource",("Session" Solo si el content es de tipo temas)]
title
stringRequired
Titulo/nombre del recurso
description
stringRequired
Descripción del recurso
resourceId
numberRequired
Identificador del recurso

Recibir resources de un módulo

Url Parameters

token
string
moduleId
string

Definition

GET https://www.apiclassonlive.com/api/v1/{token}/theme/getmoduleresources/{moduleId}

Request

Example Request

curl --request GET \
  --url https://www.apiclassonlive.com/api/v1/{token}/theme/getmoduleresources/{moduleId}

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "courseTitle": "Titulo del curso",
    "external": null,
    "creator": 13653,
    "courseType": null,
    "own": [],
    "resources": [
        {
            "resourceType": "Video",
            "title": "vídeo nuevo",
            "description": "Esta es la descripción del vídeo",
            "resourceId": 285095
        },
        {
            "resourceType": "Resource",
            "title": "Título del recurso",
            "description": "Esta es la descripción del documento",
            "resourceId": 380443
        },
        {
            "resourceType": "Session",
            "resourceId": 614091,
            "initOneDayDate": 1621404000000,
            "initMidLongDate": null,
            "endMidLongDate": null,
            "theContentDuration": "d30m",
            "theContentMethod": "Broadcast",
            "theContentType": "One_Day",
            "theAssignedExpert": "[email protected]"
        },...
    ],
    "contentIdentifier": "titulo-del-curo",
    "ok": true
}

Recibir el enlace de un resource de un módulo

Esta petición devolverá un enlace de acceso al recurso en cuestión. El parámetro resourceType solo admite los String (“Video”, “Resource”, “Session”).

Url Parameters

token
string
resourceType
string
resourceId
string

Definition

GET https://www.apiclassonlive.com/api/v1/{token}/theme/getmoduleresourcelink/{resourceType}/{resourceId}

Request

Example Request

curl --request GET \
  --url https://www.apiclassonlive.com/api/v1/{token}/theme/getmoduleresourcelink/{resourceType}/{resourceId}

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "ok": true,
    "link": "https://www.example.com/archivo.pdf"
}

VideoRecords

videoRecords

VideoRecords es el objeto que se devuelve al lanzar alguna petición de esta sección. Este objeto muestra información detallada sobre el vídeo en cuestión. Dependiendo de la petición el objeto puede mostrar mas o menos campos. En el apartado “Response Body” de cada petición se puede ver un ejemplo detallado de los campos que devuelve dicha petición.

VideoRecords Object

Attributes

id
numberRequired
Identificador usado para referenciar el vídeo
driveUrl
stringRequired
Enlace del video en Google Drive
downloadLink
stringRequired
Enlace del vídeo para descargar
users
objectRequired
Array de usuarios que tienen acceso al vídeo, si no está compartido con ningún alumno devuelve un array vacío
Expand attributesClose attributes
- canDownload
  booleanRequired
  Devuelve true si el applicant tiene permitido la descarga del vídeo
- applicantId
  numberRequired
  Identificador del applicant
- viewLink
  stringRequired
  Enlace para visualizar el vídeo
- email
  stringRequired
  Email del applicant
- name
  stringRequired
  Nombre asignado al applicant
processed
booleanRequired
El estado del vídeo. True si está procesado, false si aún no está disponible
title
stringOptional
Título del vídeo. Si no tiene título devuelve el campo vacío
moduleId
numberOptional
Identificador del módulo si el vídeo pertenece a un curso modular, de lo contrario devuelve el campo vacío
registerDate
stringRequired
La fecha en la que se añadió la grabación al curso en formato String
order
numberOptional
Orden del vídeo para mostrar
filename
stringRequired
Date transformado a String con la fecha de final del curso particular, vacío si el content es de un solo día
downloaded
booleanRequired
Devuelve true si está permitido poder descargar el vídeo, de lo contrario devuelve false
published
booleanRequired
Devuelve true si el vídeo está publicado y accesible, de lo contrario devuelve false
userLinks
objectOptional
(SOLO al pedir las grabaciones de un applicant). Objeto con los enlaces de visualización y descarga para ese applicant
Expand attributesClose attributes
- canDownload
  booleanRequired
  Devuelve true si el applicant tiene permitido la descarga del vídeo
- applicantId
  numberRequired
  Identificador del applicant,
- viewLink
  stringRequired
  Enlace para visualizar el vídeo
ok
booleanRequired
Devuelve true si no se ha producido ningún error, de lo contrario devuelve false

Pedir las grabaciones de un content

Url Parameters

token
string
contentId
string

Definition

GET https://www.apiclassonlive.com/api/v1/{token}/video_records/{contentId}

Request

Example Request

curl --request GET \
  --url https://www.apiclassonlive.com/api/v1/{token}/video_records/{contentId}

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "videos": [
        {
            "driveUrl": null,
            "id": 81583,
            "downloadLink": "https://dgi92f62wujwl.cloudfront.net/54150/SampleVideo_1280x720_10mbs.mp4",
            "users": [
                {
                    "canDownload": true,
                    "email": "[email protected]",
                    "name": "example",
                    "applicantId": 644,
                    "viewLink": "https://subdomain.classonlive.com/sala-video/therealtest-4&own&3&Z1e3YzxFffxA5Z385h58/w=="
                }
                ...
            ],
            "processed": true,
            "title": null,
            "moduleId": null,
            "order": 1,
            "registerDate": "2019-11-04",
            "filename": "54150/SampleVideo_1280x720_10mbs.mp4",
            "downloaded": false,
            "published": false
        },
        {
            "driveUrl": null,
            "id": 81584,
            "downloadLink": "https://dgi92f62wujwl.cloudfront.net/54151/IntercoachGroup21552475760317/IntercoachGroup21552475760317.m3u8",
            "users": [
                {
                    "canDownload": true,
                    "email": "[email protected]",
                    "name": "example",
                    "applicantId": 644,
                    "viewLink": "https://subdomain.classonlive.com/sala-video/therealtest-4&own&3&Z1e3YzxFffxA5Z385h58/w=="
                }
                ...
            ],
            "processed": true,
            "title": null,
            "moduleId": null,
            "order": 1,
            "registerDate": "2019-11-04",
            "filename": "IntercoachGroup21552475760317/IntercoachGroup21552475760317.m3u8",
            "downloaded": false,
            "published": false
        },
        ...
    ],
    "ok": true
}

Pedir las grabaciones de un applicant

Url Parameters

contentId
string
token
string
applicantId
string

Definition

GET https://www.apiclassonlive.com/api/v1/{token}/video_records/{contentId}/{applicantId}

Request

Example Request

curl --request GET \
  --url https://www.apiclassonlive.com/api/v1/{token}/video_records/{contentId}/{applicantId}

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "videos": [
        {
            "driveUrl": null,
            "id": 81583,
            "processed": true,
            "title": null,
            "moduleId": null,
            "order": 1,
            "registerDate": "2019-11-04",
            "filename": "54150/SampleVideo_1280x720_10mbs.mp4",
            "userLinks": {
                "downloadLink": "https://dgi92f62wujwl.cloudfront.net/54150/SampleVideo_1280x720_10mbs.mp4", // Enlace del vídeo para descargar
                "canDownload": true, // Devuelve true si el applicant tiene permitido la descarga del vídeo
                "viewLink": "https://subdomain.classonlive.com/sala-video/therealtest-4&own&81583&BctkcZnlr+GUfIDab42L/g==" // Enalce para visualizar el vídeo
            },
            "downloaded": true,
            "published": true
        }
    ],
    "ok": true
}

Compartir un video con un alumno

Url Parameters

token
string

Attributes

videoId
numberRequired
Example: 50
Identificador del vídeo
appList
objectRequired
Array de objetos que contienen a los applicants con los que se desea compartir un vídeo
Expand attributesClose attributes
- applicantId
  numberRequired
  Example: 1938
  Identificador del applicant con el que se desea compartir el vídeo
- downloadable
  booleanOptional
  True si deseas que el applicant pueda descargar también el vídeo

Definition

POST https://www.apiclassonlive.com/api/v1/{token}/video_records/publishvideo

Request

Request Headers

Content-Type: application/json

Request Body

{
    "videoId": 50,
    "appList": [{
        "applicantId": 1938, // Identificador del applicant
        "downloadable": true // True para permitir applicant la descarga del vídeo
    },
    {
        "applicantId": 1937,
        "downloadable": true
    }]

}

Example Request

curl --request POST \
  --url https://www.apiclassonlive.com/api/v1/{token}/video_records/publishvideo \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "ok": true,
    "video": {
        "driveUrl": null,
        "downloadLink": "https://dgi92f62wujwl.cloudfront.net/54150/SampleVideo_1280x720_10mbs.mp4",
        "title": null,
        "processed": true,
        "donwloaded": false,
        "moduleId": null,
        "order": 1,
        "registerDate": "2019-11-04",
        "videoId": 81583,
        "filename": "54150/SampleVideo_1280x720_10mbs.mp4",
        "published": false,
        "users": [
            {
                "canDownload": true, // Devuelve true si el applicant tiene permitido la descarga del vídeo
                "applicantId": 142836, // Identificador del applicant
                "viewLink": "https://subdomain.classonlive.com/sala-video/therealtest-4&own&81583&L80POO/O9RX1z3Wle242xg==" // Enalce para visualizar el vídeo
            },
            ...
        ]
    }
}

Despublicar un video para un alumno

Url Parameters

token
string

Attributes

videoId
stringRequired
Example: 81233
El identificador del vídeo
appList
objectRequired
Array con identificadores de alumnos (applicantId)
Expand attributesClose attributes
- applicantId
  stringRequired
  Identificador del applicant

Definition

POST https://www.apiclassonlive.com/api/v1/{token}/video_records/unpublishvideo

Request

Request Headers

Content-Type: application/json

Request Body

{
"videoId": 81583,
    "appList": [
        142836,
        ...
    ]
}

Example Request

curl --request POST \
  --url https://www.apiclassonlive.com/api/v1/{token}/video_records/unpublishvideo \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "ok": true,
    "video": {
        "driveUrl": null,
        "downloadLink": "https://dgi92f62wujwl.cloudfront.net/54150/SampleVideo_1280x720_10mbs.mp4",
        "title": null,
        "processed": true,
        "donwloaded": true,
        "moduleId": null,
        "order": 1,
        "registerDate": "2019-11-04",
        "videoId": 81583,
        "filename": "54150/SampleVideo_1280x720_10mbs.mp4",
        "published": true
    }
}

Usuarios

Usuarios General

ApplicantObject es el objeto que se devuelve al lanzar alguna petición de esta sección. Este objeto muestra información detallada sobre el usuario en cuestión. Dependiendo de la petición el objeto puede mostrar mas o menos campos. En el apartado “Response Body” de cada petición se puede ver un ejemplo detallado de los campos que devuelve dicha petición.

Usuarios General Object

Attributes

name
string
El nombre de usuario
newEmail
string
El nuevo email en caso de cmabio de email
ok
booleanRequired
Devuelve true si no se ha producido ningún error, de lo contrario devuelve false

Pedir el nombre de un usuario

Url Parameters

email
string
token
string

Definition

GET https://www.apiclassonlive.com/api/v1/{token}/username/{email}

Request

Example Request

curl --request GET \
  --url https://www.apiclassonlive.com/api/v1/{token}/username/{email}

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "name": "nombre",
    "ok": true
}

Modificar el nombre de un usuario

Url Parameters

email
string
token
string

Definition

GET https://www.apiclassonlive.com/api/v1/{token}/username/{email}

Request

Request Headers

Content-Type: application/json

Request Body

{
    "email": "[email protected]",
    "name": "name example"
}

Example Request

curl --request GET \
  --url https://www.apiclassonlive.com/api/v1/{token}/username/{email} \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "ok": true
}

Modificar el email de un usuario

Url Parameters

token
string

Attributes

email
stringRequired
`El email del usuario (alumno o profesor de tu academia)`
newEmail
stringRequired
El nuevo email

Definition

PUT https://www.apiclassonlive.com/api/v1/{token}/useremail

Request

Request Headers

Content-Type: application/json

Request Body

{
    "email": "[email protected]",
    "newEmail": "[email protected]"
}

Example Request

curl --request PUT \
  --url https://www.apiclassonlive.com/api/v1/{token}/useremail \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "newEmail": "[email protected]",
    "ok": true
}

Applicant/alumno

ApplicantObject es el objeto que se devuelve al lanzar alguna petición de esta sección. Este objeto muestra información detallada sobre el/los alumnos en cuestión. Dependiendo de la petición el objeto puede mostrar mas o menos campos. En el apartado “Response Body” de cada petición se puede ver un ejemplo detallado de los campos que devuelve dicha petición.

Applicant/alumno Object

Attributes

applicantId
number
Identificador del alumno
email
string
Email del alumno
link
string
Link para entrar a la sesión en directo para el alumno
name
string
Nombre del alumno
students
object
Array de ,objetos de alumnos de curso
Expand attributesClose attributes
- name
  string
  Nombre del alumno
- email
  string
  Email del alumno
- content
  string
  Nombre del curso
- contentId
  number
  Identificador del curso
- applicantId
  number
  Identificador del alumno
applicants
object
array de objetos de alumnos de sesión particular
Expand attributesClose attributes
- name
  string
  Nombre del alumno
- email
  string
  Email del alumno
- link
  string
  Link para entrar a la sesión en directo para el alumno
- applicantId
  number
  Identificador del alumno
isNewUser
boolean
True si el usuario es nuevo en la base de datos y requiere contraseña nueva
password
string
Contraseña (Solo si isNewUser es true)
ok
booleanRequired
Devuelve true si no se ha producido ningún error, de lo contrario devuelve false

Buscar entre tu alumnos, busqueda por nombre o email

Url Parameters

search
string
token
string

Definition

GET https://www.apiclassonlive.com/api/v1/{token}/student/search/{search}

Request

Example Request

curl --request GET \
  --url https://www.apiclassonlive.com/api/v1/{token}/student/search/{search}

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "ok": true,
    "students": [
        {
            "name": "nombre ejemplo",
            "email": "[email protected]",
            "content": "título content",
            "contentId": 20940,
            "applicantId": 115218
        },
        ...
    ]
}

Añadir un alumno a un content

Url Parameters

token
string

Attributes

contentId
stringRequired
El identificador del content
email
stringRequired
El email del alumno
name
stringRequired
El nombre del alumno
themes
arrayOptional
Solo para cuando el curso es por temas/módulos. Contiene un array de Strings con los temas a los que se desea añadir un alumno. Si no se indica temas el alumno es añadido con todos los temas del curso disponibles.

Definition

POST https://www.apiclassonlive.com/api/v1/{token}/content/student

Request

Request Headers

Content-Type: application/json

Request Body

{
    "email": "[email protected]",
    "contentId": 32960,
    "name": "nombre alumno",
    "themes": ["34","40"] // Opcional, para añadir al alumno a un tema/as en concreto. Si no se añade la clave "themes" se añadirá al alumno con todos los temas
}

Example Request

curl --request POST \
  --url https://www.apiclassonlive.com/api/v1/{token}/content/student \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "link": "https://subdomain.classonlive.com/sala-webinar/titulo-de-ejemplo?code=Xs9JH7T/neCiFL93TWAQfQ==",
    "name": "nombre alumno",
    "email": "[email protected]",
    "applicantId": 142829,
    "ok": true,
    "isNewUser": true,
    "password": "8476235" //sólo si es usuario nuevo
}

Eliminar un alumno de un content (multisesión o sesión única)

Url Parameters

token
string

Attributes

contentId
stringRequired
El identificador del content
email
stringRequired
El email del alumno

Definition

DELETE https://www.apiclassonlive.com/api/v1/{token}/content/student

Request

Request Headers

Content-Type: application/json

Request Body

{
    "email": "[email protected]",
    "contentId": 32960
}

Example Request

curl --request DELETE \
  --url https://www.apiclassonlive.com/api/v1/{token}/content/student \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "ok": true,
    "contentId": 32960,
    "email": "[email protected]"
}

Pedir datos de un alumno (multisesión o sesión única)

Url Parameters

contentId
string
token
string
email
string

Definition

GET https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}/email/{email}

Request

Example Request

curl --request GET \
  --url https://www.apiclassonlive.com/api/v1/{token}/content/{contentid}/email/{email}

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "link": "https://subdomain.classonlive.com/sala-webinar/titulo-de-ejemplo?code=Xs9JH7T/neCiFL93TWAQfQ==",
    "name": "nombre alumno",
    "email": "[email protected]",
    "applicantId": 142831,
    "ok": true
}

Añadir alumno/s a una sesión de content particular

Url Parameters

sessionId
string
token
string

Attributes

students `[{"email":"[email protected]","name":"nombre"}]`
arrayRequired

Definition

PUT https://www.apiclassonlive.com/api/v1/{token}/particular/{sessionid}/addstudent

Request

Request Headers

Content-Type: application/json

Request Body

{
    "students": [
        {
            "email":"[email protected]",
            "name":"nombre"
        },
        ...
    ]
}

Example Request

curl --request PUT \
  --url https://www.apiclassonlive.com/api/v1/{token}/particular/{sessionid}/addstudent \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "applicants": [
        {
            "applicantId": 142834,
            "email": "[email protected]",
            "name": "nombre",
            "link": "https://subdomain.classonlive.com/sala-personalizada/title-18?code=g8FK3/hKIHVHaAqRZWrjZA==&claseParticularId=85468"
        }
    ],
    "ok": true
}

Borrar alumno de sesión de content particular

Url Parameters

sessionId
string
token
string

Attributes

Definition

DELETE https://www.apiclassonlive.com/api/v1/{token}/particular/{sessionid}/removestudent

Request

Request Headers

Content-Type: application/json

Request Body

{
    "applicantId": 23734
}

Example Request

curl --request DELETE \
  --url https://www.apiclassonlive.com/api/v1/{token}/particular/{sessionid}/removestudent \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "ok": true
}

Pedir los alumnos de un content

Url Parameters

contentId
string
token
string

Definition

GET https://www.apiclassonlive.com/api/v1/{token}/student/findbycontent/{contentid}

Request

Example Request

curl --request GET \
  --url https://www.apiclassonlive.com/api/v1/{token}/student/findbycontent/{contentid}

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "students": [
        {
            "minutesConnected": 0,
            "attended": false,
            "email": "[email protected]",
            "applicantId": 142832,
            "name": "nombre alumno",
            "userAccountId": 93098,
            "themes": "49780", // Si el alumno está apuntado a todos los temas el valor de "Themes" devolverá null, de lo contrario devolverá un String con los temas individuales adquiridos
        }
    ],
    "ok": true
}

Instructores

TeacherObject es el objeto que se devuelve al lanzar alguna petición de esta sección. Este objeto muestra información detallada sobre el profesor en cuestión. Dependiendo de la petición el objeto puede mostrar mas o menos campos. En el apartado “Response Body” de cada petición se puede ver un ejemplo detallado de los campos que devuelve dicha petición.

Instructores Object

Attributes

isNewUser
boolean
True si el usuario es nuevo en la base de datos y requiere contraseña nueva password: (string) - Contraseña (Solo si isNewUser es true)
ok
booleanRequired
Devuelve true si no se ha producido ningún error, de lo contrario devuelve false

Añadir un profesor a tu academia

Url Parameters

token
string

Attributes

email
stringRequired
Example: [email protected]
Email del profesor

Definition

POST https://www.apiclassonlive.com/api/v1/{token}/teacher

Request

Request Headers

Content-Type: application/json

Request Body

{
    "email": "[email protected]"
}

Example Request

curl --request POST \
  --url https://www.apiclassonlive.com/api/v1/{token}/teacher \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "ok": true,
    "isNewUser": true,
    "paswword": "672773" //sólo si es usuario nuevo
}

Borrar un profesor de tu academia

Url Parameters

token
string

Attributes

email
stringRequired
Example: [email protected]
Email del profesor

Definition

DELETE https://www.apiclassonlive.com/api/v1/{token}/teacher

Request

Request Headers

Content-Type: application/json

Request Body

{
    "teacher": "[email protected]"
}

Example Request

curl --request DELETE \
  --url https://www.apiclassonlive.com/api/v1/{token}/teacher \
  --header 'content-type: application/json'

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "ok": true
}

Progreso

Estos métodos devuelven un objeto llamado “general” donde aparece el progreso general de cada alumno y un objeto “detail” donde aparece el progreso detallado de cada recurso del alumno.

Pedir el progreso de los alumnos de un content

Método que devuelve el progreso de los alumnos de un curso en concreto. El parámetro pageNumber es opcional y sirve para paginar. Ej: 0 -> los primeros 10 alumnos, 1 -> los siguientes 10 alumnos.

Url Parameters

contentId
string
token
string
pageNumber
string

Definition

GET https://www.apiclassonlive.com/api/v1/{token}/student/getstatsfromcontent/{contentid}/{pageNumber?}

Request

Example Request

curl --request GET \
  --url 'https://www.apiclassonlive.com/api/v1/{token}/student/getstatsfromcontent/{contentid}/{pageNumber?}='

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "stats": [
        {
            "general": {
                "progressPictureId": 16975101,
                "name": "nombre alumno",
                "registerDate": 1604331250000,
                "totalPercent": 33.33,
                "totalTime": 0,
                "applicantId": 1504891,
                "contentId": 123035,
                "email": "[email protected]",
                "register": 1604358000000,
                "country": null,
                "photo": null
            },
            "detail": [
                {
                    "progressPictureDetailId": 774634764,
                    "examTries": 0,
                    "name": "evaluacion",
                    "percent": null,
                    "resourceType": "exam",
                    "success": false,
                    "time": null,
                    "watched": false,
                    "moduleId": 111053,
                    "themeId": 24913,
                    "applicantId": 1504891,
                    "contentId": null,
                    "examId": 18551,
                    "resourceId": null,
                    "contentSessionId": null,
                    "contentExternalVideoId": null
                },
            ]
        }
    ],
    "num": 0,
    "totalPages": 1
}

Pedir el progreso del alumno de un content concreto

Url Parameters

token
string
contentId
string
applicantId
string

Definition

GET https://www.apiclassonlive.com/api/v1/{token}/student/getuserstats/{contentid}/{applicantId}

Request

Example Request

curl --request GET \
  --url https://www.apiclassonlive.com/api/v1/{token}/student/getuserstats/{contentid}/{applicantId}

Response 200

Response Headers

Content-Type: application/json

Response Body

{
    "progress":
        {
            "general": [
                {
                    "progressPictureId": 16975101,
                    "name": "nombre alumno",
                    "registerDate": 1604331250000,
                    "totalPercent": 33.33,
                    "totalTime": 0,
                    "applicantId": 1504891,
                    "contentId": 123035,
                    "email": "[email protected]",
                    "register": 1604358000000,
                    "country": null,
                    "photo": null
                },
            ]
            "detail": [
                {
                    "progressPictureDetailId": 774634764,
                    "examTries": 0,
                    "name": "eva",
                    "percent": null,
                    "resourceType": "exam",
                    "success": false,
                    "time": null,
                    "watched": false,
                    "moduleId": 111053,
                    "themeId": 24913,
                    "applicantId": 1504891,
                    "contentId": null,
                    "examId": 18551,
                    "resourceId": null,
                    "contentSessionId": null,
                    "contentExternalVideoId": null
                },
            ]
        }
    ],
    "num": 0,
    "totalPages": 1
}

Ejemplos

Crear content por temas/módulos

Pincha aquí para ver un ejemplo de como crear un curso por temas.