YuJa API

Todennus

Jokainen API-kutsu vaatii todennustunnuksen otsakkeena. Nämä tunnukset luovat IT-pääkäyttäjät/ylläpitäjät, ja ne voidaan peruuttaa. Todennustunnukset mahdollistavat API-käytön tiettyyn oppilaitokseen. Tunnus on 32 merkkiä pitkä, ja se voidaan hakea kohdasta Hallintapaneeli -> API.

Muista tallentaa API-tunnus myös sen luomisen jälkeen.

Tunnuksen käyttö: Tunnus on välitettävä otsakkeena, jonka avain on ”authToken” ja arvo on tunnus, jokaisessa API-kutsussa

API:n perus-URL

Nykyisen YuJa API:n perus-URL on {organization_subdomain}.yuja.com/services/. Organization_subdomain määritetään, kun Organisaatio-tili luodaan YuJassa. Turvallisuussyistä vain https-yhteys on sallittu. Jos esimerkiksi organisaatiolle määritetty verkkotunnus on tested, aloitussivu on api-testing.yuja.com ja API-päätepiste on api-testing.yuja.com/services.

Pyyntöparametrit

API-kutsujen pyyntöparametrit voidaan välittää usealla tavalla.

• URL-polun osana. Tätä kutsutaan polkuparametriksi.
• Kyselymerkkijonon osana. Tätä kutsutaan kyselymerkkijonoparametriksi.
• Pyynnön rungossa muissa kuin GET-pyynnöissä. Tätä kutsutaan runkoparametriksi. Sisältö on koodattava JSON-muotoon.
• Mukautetussa HTTP-otsakkeessa. Tätä kutsutaan otsakeparametriksi.

CRUD-toiminnot

APIt noudattavat REST-käytäntöä CREATE-, READ-, UPDATE- ja DELETE-toimintojen toteuttamiseksi. Seuraavassa taulukossa kuvataan käytetty yleinen käytäntö.

REST API:n vastauskoodit

1 - Käyttäjä-API:n yleiskatsaus

Käyttäjät edustavat kaikkia oppilaitokseen rekisteröityjä käyttäjiä. Näihin kuuluvat opettajat, opiskelijat ja IT-pääkäyttäjät. Käyttäjät voidaan ilmoittaa kursseille, he voivat luoda tallenteita ja pyytää kokouksia, kutsua muita kokouksiin tai saada kutsuja niihin. Käyttäjillä voi myös olla videokokoelma.

1.1 - Käyttäjäobjektimalli

Saat käyttäjien user_id-arvot tekemällä ensin API-kutsun GET /users (kohta 1.2.1). Vastauksesta voidaan kerätä kaikkien käyttäjien user_id, jota voidaan käyttää myöhemmin muissa API-kutsuissa.

1.2 - Tärkeimmät päätepisteet

1.2.1 - GET /services/users

Palauttaa JSON-muotoisen objektiluettelon, jossa kukin objekti on käyttäjä. Tähän kutsuun ei tarvita parametreja.

Esimerkki-URL: https://api-testing.yuja.com/services/users

Esimerkkivastaus:

[

{

"login_id": "loginID123",

"user_status": "Active",

"user_type": "IT Manager",

"user_id": "3432",

"timezone": "America/New_York",

"last_name": "doe,

"phone_number": "123-456-7890",

"first_name": "john",

"email": "john.doe@yuja.com"

},

{

"login_id": "loginID456",

"user_status": "Suspended",

"user_type": “Student",

"user_id": "44",

"timezone": "Canada/Easter",

"last_name": "doe",

"phone_number": "123-456-7890",

"first_name": "jane",

"email": "jane.doe@yuja.com"

}

]

1.2.2 - GET /services/users/{user_id}

Palauttaa JSON-objektin, joka sisältää opiskelijan tiedot.

Esimerkki-URL: https://api-testing.yuja.com/services/users/3432

Parametrit:

Esimerkkivastaus:

{
"login_id": "loginID123",
"user_type": "IT Manager",
"user_id": "3432",
"timezone": "America/New_York",
“custom_id”: ”otherName”,
"last_name": "doe",
"phone_number": "123-456-7890",
"first_name": "john",
"email": "john.doe@yuja.com"
}

1.2.3 - POST /services/users

Luo uuden käyttäjän oppilaitokseen. JSON-data voidaan muodostaa ilman valinnaisia parametreja. Katso parametrien tiedot kohdasta 1.1.

Esimerkki-URL: https://api-testing.yuja.com/services/users

Parametrit:

Tämä päätepiste odottaa runkoparametrissa JSON-dataa tässä muodossa:

{
"email_address": String email,
"first_name": String firstName,
"last_name": String lastName,
"login_id": String logidID,
"login_password": String password,
"custom_id": String custom_id,
"user_type": String userType,
"phone_number”: String phoneNumber
}

Esimerkki-JSON-data:

{
"login_id": "IT_1",
"user_type": "IT Manager",
"last_name": "doe",
"login_password": "Password1@gmail.com",
"phone_number": "123-456-7890",
"first_name": "john",
"email_address": "john.doe@yuja.com"
}

1.2.4 - PUT /services/users/{user_id}

Päivittää yksittäisen käyttäjän {user_id}:n perusteella. Katso parametrien tiedot kohdasta 1.1.

Esimerkki-URL:https://api-testing.yuja.com/services/users/1000

Parametrit:

Tämä päätepiste odottaa runkoparametrissa JSON-dataa tässä muodossa:

{
"email_address": String email,
"first_name": String firstName,
"last_name": String lastName,
"login_password": String password,
"custom_id": String custom_id,
"timezone": String timeZone,
"user_type": String userType,
"phone_number”: String phoneNumber
}

Kaikki kentät ovat valinnaisia. Vain annetut kentät päivitetään.

1.2.5 - DELETE /services/users/{user_id}

Poistaa käyttäjän, jonka ID on {user_id}, oppilaitoksesta.

Esimerkki-URL: https://api-testing.yuja.com/services/users/1000

Parametrit:

1.2.6 - GET /services/users/{user_id}/groups/members

Hakee kaikki ryhmät, joihin käyttäjä on ilmoittautunut.

Esimerkki-URL: https://api-testing.yuja.com/services/users/3432/groups/members

Parametrit:

Esimerkkivastaus:

[
{
"publish_type": "ALL",
"is_active": "1",
"group_code": "GROUP_CODE",
"group_id": 1365,
"group_name": "Name of group",
"owner_id": "2469",
"group_security": "FREE_JOIN",
"group_term": "Fall 2020"
},
{
"publish_type": "ADMIN",
"is_active": "1",
"group_code": "354",
"group_id": 121,
"group_name": "Name of group",
"owner_id": "898",
"group_security": "INVITE_ONLY",
"group_term": "Spring 2020"
}
]

1.2.7 - GET /services/users/{user_id}/groups/content_owners

Hakee kaikki ryhmät, joiden sisällön omistaja käyttäjä on. Tarvittava user_id voidaan hakea API-kutsulla GET /users.

Esimerkki-URL: https://api-testing.yuja.com/services/users/2469/groups/content_owners

Parametrit:

Parametreja ei tarvita.

Esimerkkivastaus:

[
{
"publish_type": "ALL",
"is_active": "1",
"group_code": "GROUP_CODE",
"group_id": 1365,
"group_name": "Name of group",
"owner_id": "2469",
"group_security": "FREE_JOIN",
"group_term": "Fall 2020"
},
{
"publish_type": "ADMIN",
"is_active": "0",
"group_code": "354",
"group_id": 121,
"group_name": "Invite Only",
"owner_id": "2469",
"group_security": "INVITE_ONLY",
"group_term": "Spring 2020"
}
]

1.2.8 - POST /services/users/addUserWithExternalIdentifier

Luo uusia käyttäjiä samoilla parametreilla kuin post services- ja user-päätepisteet (katso kohta 1.2.3) kahdella lisäparametrilla: primary_identifier ja secondary_identifier. Tämä yhdistää käyttäjän olemassa oleviin tai tuleviin käyttäjiin, jotka on luotu LMS- tai SSO-integraation kautta. Vaikka primary_identifier ja secondary_identifier ovat valinnaisia, toisen niistä on oltava mukana. Ota tarvittaessa yhteyttä YuJa-tukeen.

Esimerkki-URL: https://api-testing.yuja.com/services/users/primary_identifier

Parametrit:

1.2.9 - POST /services/media/permission

Lisää tai muokkaa kansioiden käyttöoikeuksia CampusTubessa tai EnterpriseTubessa.

Esimerkki-URL: https://api-testing.yuja.com/services/media/permission

Parametrit:
Tähän kutsuun ei tarvita parametreja.

Esimerkki-JSON-data:

Tämä päätepiste odottaa runkoparametrissa JSON-dataa tässä muodossa:

Käytä alla olevaa JSON-syötettä, kun määrität roolin perusteella:
{
"folderID": "9931153",
"type": "Role",
"name": "Student" OR "Instructor",
"updateDescendants": "true" OR "false",
"access": "Full Access" OR "Edit Access'" OR "Edit Caption Access" OR "Read Access"
}

Käytä alla olevaa JSON-syötettä, kun määrität käyttäjän perusteella:
{
"folderID": "9931153",
"type": "User",
"updateDescendants": "true" OR "false",
"userName": "username",
"access": "Full Access" OR "Edit Access" OR "Edit Caption Access" OR "Read Access"
}

Käytä alla olevaa JSON-syötettä, kun määrität ryhmän perusteella:
{
"folderID": "9931153",
"type": "Group",
"updateDescendants": "true" OR "false",
"groupName": "group name",
"access": "Full Access" OR "Edit Access" OR "Edit Caption Access" OR "Read Access"
}

Esimerkkivastaus:

Successfuly Modified permission

1.2.10 - DELETE /services/media/permission

Poistaa kansion käyttöoikeudet.

Esimerkki-URL: https://api-testing.yuja.com/services/media/permission

Parametrit:
Tähän kutsuun ei tarvita parametreja.

Esimerkki-JSON-data:

Tämä päätepiste odottaa runkoparametrissa JSON-dataa tässä muodossa:

Käytä alla olevaa JSON-syötettä, kun määrität roolin perusteella:
{
"folderID":"9931153",
"type": "Role",
"name": "Student" OR "Instructor"
}

Käytä alla olevaa JSON-syötettä, kun määrität käyttäjän perusteella:
{
"folderID": "9931153",
"type": "User",
"userName": "username"
}

Käytä alla olevaa JSON-syötettä, kun määrität ryhmän perusteella:
{
"folderID": "9931153",
"type": "Group",
"groupName": "group name"
}

Esimerkkivastaus:

Success

1.2.11 - POST /services/media/mediaByLinkageValue

Hakee tietoja käyttäjän tilillä olevista videoista ”linkage”-arvon avulla. Arvon saa Luminan kohdasta Hallintapaneeli > Osallistujaluettelo tarkastelemalla käyttäjän Linkage-saraketta. Valitse sarakkeesta käyttäjän linkage-tyyppi ja kopioi annettu LTI Linkage-, LTI3 Linkage- tai SAML Linkage -arvo.

Esimerkki-URL: https://api-testing.yuja.com/services/media/mediaByLinkageValue

Parametrit:
Tähän kutsuun ei tarvita parametreja.

Esimerkki-JSON-data:

Tämä päätepiste odottaa runkoparametrissa JSON-dataa tässä muodossa:

{
"linkage": "stu.bct"
}

Esimerkkivastaus:

[

{

"createdDate": "2023-08-24 06:01:06",

"duration": "131.968",

"ownerName": "Miley Kendra",

"videoDesc": "",

"videoPID": 322731,

"videoTags": [

[]

],

"videoTitle": "Live Recording"

},

{

"createdDate": "2022-07-11 12:43:42",

"duration": "121.54",

"ownerName": "Sales Rep",

"videoDesc": "",

"videoPID": 265367,

"videoTags": [

[]

"videoTitle": "Presentation"

],

]

1.2.12 - POST /services/media/modifySharePermissions

Lisää käyttäjän jaettuun kansioon määritetyillä käyttöoikeuksilla.

Esimerkki-URL: https://hudson.yuja.com/services/media/modifySharePermissions

Parametrit:

Esimerkki-JSON-data:

Tämä päätepiste odottaa runkoparametrissa JSON-dataa tässä muodossa:

{
"node_id":"10265558",
"user_id":"tryan",
"share_list":[
{
"share_with_user_id":"smichael",
"access_level":"Edit Access"
},
{
"share_with_user_id":"alia",
"access_level":"Edit Caption Access"
}
]
}

Esimerkkivastaus:

Share list successfully updated.

1.2.13 - DELETE /services/media/modifySharePermissions

Poistaa käyttäjän jaetusta kansiosta.

Esimerkki-URL: https://hudson.yuja.com/services/media/modifySharePermissions

Parametrit:

Esimerkki-JSON-data:

Tämä päätepiste odottaa runkoparametrissa JSON-dataa tässä muodossa:

{
"node_id":"10352458",
"user_id":"tryan",
"delete_list":[
"alia", "smichael", "rkhan"
]
}

Esimerkkivastaus:

Share list successfully updated.

1.2.14 - PUT /services/users/updateStatus

Muuttaa käyttäjän tilin tilaa käyttäjän ID:n, kirjautumistunnuksen tai sähköpostiosoitteen avulla. Voit päivittää useita käyttäjiä kerralla käyttämällä luetteloa käyttäjien ID:istä, kirjautumistunnuksista tai sähköpostiosoitteista. Yhteensä on annettava kaksi parametria: email TAI login_id TAI user_id sekä status.

Esimerkki-URL: https://hudsonlake.yuja.com/services/users/updateStatus

Parametrit:

Tilin tilan muuttaminen user_id:n avulla

Esimerkki-JSON-data:

Tämä päätepiste odottaa runkoparametrissa JSON-dataa tässä muodossa:

{
"user_id":"brendansheedy,caseymelvin,cecilleminkov,danielsteen",
"status":"active"
}

Esimerkkivastaus:

The status for the given user(s) has been successfully updated.

Tilin tilan muuttaminen sähköpostiosoitteen avulla

Esimerkki-JSON-data:

Tämä päätepiste odottaa runkoparametrissa JSON-dataa tässä muodossa:

{
"email":"brendan.sheedy@yuja.com,caseymelvin@yuja.com,cecilie.minkov@yuja.com,daniel.steen@yuja.com",
"status":"suspended"
}

Esimerkkivastaus:

The status for the given user(s) has been successfully updated.

2 - Ryhmä-API:n yleiskatsaus

Ryhmät edustavat kaikkia organisaatiossa saatavilla olevia kursseja. Jokaisella kurssilla on omat kurssin suojausasetukset, jotka rajaavat käyttäjien pääsyä kurssille. Kurssi voi myös julkaista käytäntöjä, joiden mukaan vain tietyntyyppiset käyttäjät saavat julkaista kyseisiin ryhmiin.

Huomaa: Kun pyrimme erottamaan kurssit ja ryhmät toisistaan, nykyiset kohtien 2.2.1–2.2.13 API:t toimivat toistaiseksi normaalisti. Siirtyäksesi kurssien ajantasaisimpiin API:hin suosittelemme käyttämään kohtien 2.2.14–2.2.23 API:ita. Ryhmäkohtaisia API:ita varten siirry alla olevaan osioon ”3 - UserGroups-API:n yleiskatsaus”.

2.1 - Ryhmäobjektimalli

Saat ryhmien group_id-arvot tekemällä ensin API-kutsun GET /groups (kohta 2.2.1). Vastauksesta voidaan kerätä kaikkien ryhmien group_id, jota voidaan käyttää myöhemmin muissa API-kutsuissa.

2.2 - Keskeiset päätepisteet

2.2.1 - GET /services/groups

Palauttaa JSON-luettelon kaikista ryhmistä, jotka on järjestetty sivuille niin, että kullakin sivulla on 1000 ryhmää. Jos haluat palauttaa kaikki ryhmät yhdelle sivulle, ota yhteyttä asiakkuuspäällikköösi, jotta tämän rajapinnan toimintaa voidaan muuttaa oppilaitoksellesi. Huomautus: Kaikkia ryhmiä ei voi palauttaa yhdelle sivulle 31. joulukuuta 2023 jälkeen.

Esimerkki-URL: https://api-testing.yuja.com/services/groups?page=2&sortDescending=false

Parametrit:

Esimerkkivastaus:

[
{
"publish_type":"CURATE",
"is_active":true,
"group_code":"FALL 2020",
"group_id":1536,
"group_name":"Name of Group",
"owner_id":2468,
"sis_id":"996633",
"group_security":"INVITE_ONLY",
"group_term":"Default Term"v },
{,
"publish_type":"ADMIN",
"is_active":true,
"group_code":"",
"group_id":1098,
"group_name":"Name of Group",
"owner_id":1588,
"sis_id":"996633",
"group_security":"INVITE_ONLY",
"group_term":"Default Term"
}
]

2.2.2 - GET /services/groups/{group_id}

Palauttaa JSON-objektin, joka sisältää ryhmän tiedot.

Esimerkki-URL: https://api-testing.yuja.com/services/groups/1098

Parametrit:

Esimerkkivastaus:

{
"publish_type": "ADMIN",
"is_active": “0”,
"group_code": "ECE150",
"group_id": 1098,
"group_name": "Math Class",
"owner_id": 1588,
"group_security": "INVITE_ONLY"
}

2.2.3 - PUT /services/groups/{group_id}

Muokkaa ryhmän, jonka tunnus on {group_id}, tietoja. Parametrien tiedot ovat kohdassa 2.1.

Esimerkki-URL: https://api-testing.yuja.com/services/groups/1098

Parametrit:

Tämä päätepiste odottaa JSON-tietoja tässä muodossa runkoparametrissa:

{
"group_name": String group_name,
"group_code": String group_code,
"group_term": String group_security,
"publish_type": String publish_type
}

Kaikki kentät ovat valinnaisia. Vain annetut kentät päivitetään.

2.2.4 - POST /services/groups

Luo uuden ryhmän. Parametrien tiedot ovat kohdassa 2.1.

Esimerkki-URL: https://api-testing.yuja.com/services/groups

Tämä päätepiste odottaa JSON-tietoja tässä muodossa runkoparametrissa:

{
"owner_id": Integer owner_id,
"group_name": String group_name,
"group_code": String group_code,
"group_term": String group_term,
"publish_type": String publish_type
}

2.2.5 - DELETE /services/groups/{group_id}

Poistaa ryhmän/kurssin, jonka tunnus on {group_id}, oppilaitoksesta.

Esimerkki-URL: https://api-testing.yuja.com/services/groups/1098

Parametrit:

2.2.6 - POST /services/groups/{group_id}/members/add/{user_id}

Lisää käyttäjän ryhmään jäseneksi.

Esimerkki-URL: https://api-testing.yuja.com/services/groups/1098/members/add/1000

Parametrit:

2.2.7 - POST /services/groups/{group_id}/content_owners/add/{user_id}

Lisää käyttäjän ryhmään sisällön omistajaksi.

Esimerkki-URL: https://api-testing.yuja.com/services/groups/1098/content_owners/add/1000

2.2.8 - GET /services/groups/{group_id}/content_owners

Palauttaa JSON-luettelon objekteista, joissa kukin objekti on käyttäjä, joka on sellaisen ryhmän sisällön omistaja, jonka tunnus on {group_id}.

Esimerkki-URL: https://api-testing.yuja.com/services/groups/1098/content_owners

Esimerkkivastaus:

[
{
"login_id": "loginID123",
"user_type": "IT Manager",
"user_id": "3432",
"timezone": "America/New_York",
"last_name": "doe",
"phone_number": "123-456-7890",
"first_name": "john",
"email": "john.doe@yuja.com"
},
{
"login_id": "loginID456",
"user_type": “Student",
"user_id": "44",
"timezone": "Canada/Easter",
"last_name": "doe",
"phone_number": "123-456-7890",
"first_name": "jane",
"email": "jane.doe@yuja.com"
}
]

2.2.9 - GET /services/groups/{group_id}/members

Palauttaa JSON-luettelon objekteista, joissa kukin objekti on käyttäjä, joka on sellaisen ryhmän jäsen, jonka tunnus on {group_id}.

Esimerkki-URL: https://api-testing.yuja.com/services/groups/1098/members

Parametrit:

Esimerkkivastaus:

[
{
"login_id": "loginID123",
"user_type": "IT Manager",
"user_id": "3432",
"timezone": "America/New_York",
"last_name": "doe",
"phone_number": "123-456-7890",
"first_name": "john",
"email": "john.doe@yuja.com"
},
{
"login_id": "loginID456",
"user_type": “Student",
"user_id": "44",
"timezone": "Canada/Easter",
"last_name": "doe",
"phone_number": "123-456-7890",
"first_name": "jane",
"email": "jane.doe@yuja.com"
}
]

2.2.10 - DELETE /services/groups/{group_id}/members/{user_id}

Poistaa jäsenen, jonka tunnus on {user_id}, ryhmästä, jonka tunnus on {group_id}.

Esimerkki-URL: https://api-testing.yuja.com/services/groups/1098/members/1000

Parametrit:

2.2.11 - DELETE /services/groups/{group_id}/content_owners/{user_id}

Poistaa sisällön omistajan, jonka tunnus on {user_id}, ryhmästä, jonka tunnus on {group_id}.

Esimerkki-URL: https://api-testing.yuja.com/services/groups/1098/content_owners/1000

Parametrit:

2.2.12 - GET /services/groups/groupCode/{group_code}

Palauttaa annetun ryhmäkoodin (kurssikoodin) ryhmän tiedot.

Esimerkki-URL: https://api-testing.yuja.com/services/groups/groupCode/123

Parametrit:

Esimerkkivastaus:

[
{
"publish_type": "ADMIN",
"is_active": 1,
"group_code": "123 ",
"group_id": 138,
"group_name": "scriptTest",
"owner_id": 148,
"sis_id": 0,
"group_security": "INVITE_ONLY",
"group_term": "Spring 2017"
},
{
"publish_type": "ALL",
"is_active": 1,
"group_code": "123",
"group_id": 172,
"group_name": "TestNumber222", "owner_id": 43,
"sis_id": 0,
"group_security": "INVITE_ONLY",
"group_term": "Spring 2017"
}
]

2.2.13 - POST /services/users/createGroup

Luo ryhmiä ja/tai lisää jäseniä ryhmiin.

Esimerkki-URL: https://evergreen.yuja.com/services/users/createGroup

Parametrit:

Tämä kutsu ei tarvitse parametreja.

Esimerkki JSON-tiedoista:

Tämä päätepiste odottaa JSON-tietoja tässä muodossa runkoparametrissa:

{

"groupName": "ChemistryGroup",

"groupMembers": "374983,342842,418637 (can be left empty)"

}

Esimerkkivastaus:

Group created successfully

2.2.14 - GET /services/courses/code/{course_code}

Palauttaa annetun kurssikoodin kurssin tiedot.

Esimerkki-URL:https://api-testing.yuja.com/services/courses/code/BIO232

Parametrit:

Esimerkkivastaus:

{

"embed_code": "<iframe width='100%' height='540' src=\"https://evergreen.yuja.com/V/PlayList?node=391100&a=1510937947&preload=false\" frameborder=\"0\" webkitallowfullscreen mozallowfullscreen allowfullscreen loading=\"lazy\"></iframe>",

"publish_type": "ALL",

"is_active": 1,

"group_code": "BIO232",

"group_id": 8610,

"group_name": "Intro to Microbiology",

"owner_id": 71923,

"sis_id": 0,

"group_security": "INVITE_ONLY",

"group_term": "Winter 2015",

"direct_link": "https://evergreen.yuja.com/V/PlayList?node=311900&a=1510937147"

}

2.2.15 - DELETE /services/courses/{course_id}/owners/{user_id}

Poistaa kurssin omistajan.

Esimerkki-URL: https://api-testing.yuja.com/services/courses/152463/owners/782915

Parametrit:

Esimerkkivastaus:

Successfully deleted user from group/class

2.2.16 - DELETE /services/courses/{course_id}/members/{user_id}

Poistaa kurssiin kuuluvan jäsenen.

Esimerkki-URL: https://api-testing.yuja.com/services/courses/2463/members/782295

Parametrit:

Esimerkkivastaus:

Successfully deleted user from group/class

2.2.17 - GET /services/courses/{course_id}/owners

Hakee kurssin omistajat.

Esimerkki-URL: https://api-testing.yuja.com/services/courses/2463/owners

Parametrit:

Esimerkkivastaus:

{
"login_id":"zmasht4","email_address":"zaid.masht@yuja.com","user_type":"Instructor","user_id":"609","timezone":"Canada/Eastern","custom_id":"8763","last_name":"Masht","phone_number":"745-286-8877","first_name":"Zaid"
}

2.2.18 - DELETE - /services/courses/{course_id}

Poistaa kurssin.

Esimerkki-URL: https://api-testing.yuja.com/services/courses/2463

Parametrit:

Esimerkkivastaus:

Successfully deleted course/class

2.2.19 - PUT /services/courses/{course_id}

Muokkaa olemassa olevaa kurssia.

Esimerkki-URL: https://api-testing.yuja.com/services/courses/2463

Parametrit:

Tämä päätepiste odottaa JSON-tietoja tässä muodossa runkoparametrissa:

{
"course_name": "newcoursename",
"course_code": "999676",
"course_term": "winter",
"is_active": true;
}

Esimerkkivastaus:

Successfully updated course of id: 2463

2.2.20 - POST /services/courses/{course_id}/owners/{user_id}

Lisää omistajan olemassa olevaan kurssiin.

Esimerkki-URL: https://api-testing.yuja.com/services/courses/2463/owners/74927

Parametrit:

Esimerkkivastaus:

Successfully made user a content owner to this course/class

2.2.21 - POST /services/courses/{course_id}/members/{user_id}

Lisää jäsenen olemassa olevaan kurssiin.

Esimerkki-URL: https://api-testing.yuja.com/services/courses/2463/members/74927

Parametrit:

Esimerkkivastaus:

Successfully made user a member to this course/class

2.2.22 - POST /services/courses

Luo uuden kurssin.

Esimerkki-URL: https://api-testing.yuja.com/services/courses

Tämä päätepiste odottaa JSON-tietoja tässä muodossa runkoparametrissa:

{

"owner_id": 374971,

"course_name": "newcourse1",

"course_code": "999000",

"course_term": "Summer",

"publish_type": "ADMIN"

}

Esimerkkivastaus:

Successfully created a new course

2.2.23 - GET /services/courses

Hakee kurssien tiedot 200 kurssin erissä.

Esimerkki-URL: https://api-testing.yuja.com/services/courses

Esimerkkivastaus:

{"embed_code":"<iframe width='100%' height='540' src=\"https://evergreen.yuja.com/V/PlayList?node=1004712&a=90319216&preload=false\" frameborder=\"0\" webkitallowfullscreen mozallowfullscreen allowfullscreen loading=\"lazy\"><\/iframe>","course_id":15129,"publish_type":"ADMIN","is_active":true,"course_code":"99000","course_name":"newcourse1","owner_id":374971,"sis_id":"","course_security":"INVITE_ONLY","course_term":"Summer","direct_link":"https://evergreen.yuja.com/V/PlayList?node=10147412&a=9039216"},
{"embed_code":"<iframe width='100%' height='540' src=\"https://evergreen.yuja.com/V/PlayList?node=1004680&a=25455921&preload=false\" frameborder=\"0\" webkitallowfullscreen mozallowfullscreen allowfullscreen loading=\"lazy\"><\/iframe>","course_id":151484,"publish_type":"ADMIN","is_active":true,"course_code":"bio1011","course_name":"bio","owner_id":368555,"sis_id":"","course_security":"INVITE_ONLY","course_term":"Winter 2022","direct_link":"https://evergreen.yuja.com/V/PlayList?node=10046201&a=2455921"}

3 - UserGroups API:n yleiskuvaus

UserGroups edustaa kaikkia organisaatiossa käytettävissä olevia ryhmiä. Jokaisella ryhmällä on yksilöllinen tunnus ja jäseniä, joita voidaan lisätä tai poistaa.

3.1 - Laiteobjektimalli

3.2 - Tärkeimmät päätepisteet

3.2.1 - GET /services/usergroups/all

Hakee kaikki ryhmät.

Esimerkki-URL: https://api-testing.yuja.com/services/usergroups/all

Esimerkkivastaus:

{"userGroupPID":{"value":269},"groupName":"Anthropology","institutePID":2},{"userGroupPID":{"value":297},"groupName":"NewGroup","institutePID":2},{"userGroupPID":{"value":298},"groupName":"Group","institutePID":2}

3.2.2 - GET /services/users/{user_id}/userGroups

Hakee kaikki ryhmät, joihin käyttäjä kuuluu.

Esimerkki-URL: https://api-testing.yuja.com/services/users/3276/userGroups

Parametrit:

Esimerkkivastaus:

[
Anthropology, Microbiology, AdminGroup
]

3.2.3 - GET /services/usergroups/name/members

Hakee kaikki ryhmän jäsenet ryhmän nimen perusteella.

Esimerkki-URL: https://api-testing.yuja.com/services/usergroups/name/members

Tämä päätepiste odottaa rungon parametrissa JSON-dataa tässä muodossa:

{
"groupName":"anthropology"
}

Esimerkkivastaus:

[
275749, 352461, 355740, 362283, 380225, 381147
]

3.2.4 - GET /services/usergroups/{group_id}/members

Hakee kaikki ryhmän jäsenet ryhmän tunnuksen perusteella.

Esimerkki-URL: https://api-testing.yuja.com/services/usergroups/73527/members

Parametrit:

Esimerkkivastaus:

[
472862, 840173, 294591
]

3.2.5 - GET /services/usergroups/{group_id}

Hakee ryhmän tiedot ryhmän tunnuksen perusteella.

Esimerkki-URL: https://api-testing.yuja.com/services/usergroups/73527/members

Parametrit:

Esimerkkivastaus:

{"value":{"userGroupPID":{"value":298},"groupName":"Admin Group","institutePID":2}}

3.2.6 - POST /services/usergroups/create

Luo ryhmän ja lisää jäseniä. Jos ryhmä on jo olemassa, jäsenet lisätään siihen. Jos haluat luoda ryhmän ilman jäseniä, kirjoita "groupMembers":"" JSON-dataan.

Esimerkki-URL: https://api-testing.yuja.com/services/usergroups/create

Tämä päätepiste odottaa rungon parametrissa JSON-dataa tässä muodossa:

{
"groupName":"Admin Group",
"groupMembers":"37291,34370"
}

Esimerkkivastaus:

Group created and Members added successfully

3.2.7 - PUT /services/usergroups/{group_id}

Muokkaa ryhmän nimeä.

Esimerkki-URL: https://api-testing.yuja.com/services/usergroups/482

Parametrit:

Tämä päätepiste odottaa rungon parametrissa JSON-dataa tässä muodossa:

{
"groupId":"847",
"groupName":"Admin Group"
}

Esimerkkivastaus:

Successfully changed the group name

3.2.8 - DELETE /services/usergroups/{group_id}

Poistaa ryhmän nimen.

Esimerkki-URL: https://api-testing.yuja.com/services/usergroups/482

Parametrit:

Esimerkkivastaus:

Successfully deleted the group

3.2.9 - DELETE /services/usergroups/{group_id}/clear

Poistaa kaikki jäsenet ryhmästä.

Esimerkki-URL: https://api-testing.yuja.com/services/usergroups/482/clear

Parametrit:

Esimerkkivastaus:

Successfully cleared group members

3.2.10 - DELETE /services/usergroups/{group_id}/members/{user_id}

Poistaa tietyn ryhmän jäsenen tämän tunnuksen perusteella.

Esimerkki-URL: https://api-testing.yuja.com/services/usergroups/482/members/73847

Parametrit:

Esimerkkivastaus:

Successfully deleted group member

3.2.11 - POST /services/usergroups/foldersByGroupPID

Hakee luettelon kansioista, joihin määritetyllä ryhmällä on pääsy.

Esimerkki-URL: https://api-testing.yuja.com/services/usergroups/foldersByGroupPID

Parametrit:

Esimerkkipyyntö:

{
"pageNumber":1,
"pageSize":10,
"groupPID":368
}

Esimerkkivastaus:

[
{
"folderPID": 10301538,
"folderTitle": "123321",
"directLink": "https://evergreen.yuja.com/V/PlayList?node=10301538&a=514129661",
"embedCode": "<iframe width='100%' height='540' src=\"https://evergreen.yuja.com/V/PlayList?node=10301538&a=514129661&preload=false\" frameborder=\"0\" webkitallowfullscreen mozallowfullscreen allowfullscreen loading=\"lazy\"></iframe>",
"folderVideosCount": 1
},
{
"folderPID": 10350161,
"folderTitle": "arjun internal lib test",
"directLink": "https://evergreen.yuja.com/V/PlayList?node=10350161&a=577455668",
"embedCode": "<iframe width='100%' height='540' src=\"https://evergreen.yuja.com/V/PlayList?node=10350161&a=577455668&preload=false\" frameborder=\"0\" webkitallowfullscreen mozallowfullscreen allowfullscreen loading=\"lazy\"></iframe>",
"folderVideosCount": 0
}
]

4 - Device API:n yleiskuvaus

Laitteet edustavat kaikkia organisaatioon rekisteröityjä tallennuslaitteita. Jokaiselle laitteelle voidaan halutessa antaa IP-osoite hallintakäyttöliittymässä. Tämä tunnus haetaan muiden laitetunnusten mukana.

4.1 - Laiteobjektimalli

4.2 - Tärkeimmät päätepisteet

4.2.1 - GET /services/devices

Palauttaa JSON-luettelon objekteista, joista jokainen objekti on laite.

Esimerkki-URL: https://api-testing.yuja.com/services/devices

Parametrit:

Tämä kutsu ei tarvitse parametreja.

Esimerkkivastaus:

{
{
"name": "station1",
"device_type": "software_capture",
"access_level": "it_admin",
“device_id ” : “12345”,
“register_user_id” : “user1”
},
{
"name": "station2",
"device_type": "hardware_capture",
"access_level": "me",
“device_id ” : “12346”,
“register_user_id” : “user2”
}
}

4.2.2 - GET /services/devices/{device_id}

Palauttaa JSON-objektin, joka on laite.

Esimerkki-URL: https://api-testing.yuja.com/services/devices/12456

Parametrit:

Esimerkkivastaus:

{
"name": "station2",
"device_type": "hardware_capture",
"access_level": "me",
“device_id ” : “12346”,
“register_user_id” : “user2”
}

4.2.3 - PUT /services/devices/{device_id}

Päivittää laitteen.

Esimerkki-URL: https://api-testing.yuja.com/services/devices/12345

Parametrit:

4.2.4 - POST /services/devices/register

Rekisteröi laitteen. Voit muokata laitetta rekisteröinnin jälkeen käyttämällä olemassa olevaa päätepistettä PUT /devices/{device_id}.

Esimerkki-URL: https://api-testing.yuja.com/services/devices/register

Parametrit:

Esimerkkipyyntö:

{
"access_id": "r0RQUYSM89TvCo9sm3AM",
"display_name" : "Device 1",
"device_model": "",
"firmware_version": "1.0",
"user_identifier": "username",
"user_identifier_type": "LOGIN",
"configuration": "",
"contact_list" :"11111, 11112, user@gmail.com",
"save_folder": "/MyMediaCollections/84fbbff5-b2bf-42ad-8b05-a5a227b0462e/6cfc190f-f7a4-4010-899d-b70456668e7c"
}

Esimerkkivastaus:

{
“success”: “true”,
“error_message”: “”,
“id”: “12345”
}

4.2.5 - GET /services/devices/registrations/{access_Id}

Vaihtoehtoinen tapa hakea laitetiedot GET-kutsulla käyttämällä access_id:tä Luminan sisäisen device_id:n sijaan. Käytettävissä vain laitetyypeille, jotka käyttävät access_id:tä.

Esimerkki-URL: https://api-testing.yuja.com/services/devices/registrations/r0RQUYSM89TvCo9sm3AM

Parametrit:

Esimerkkivastaus:

{
"name": "station1",
"device_type": "software_capture",
"access_level": "it_admin",
“device_id” : “12345”,
“register_user_id” : “user1”
}

4.2.6 - GET /services/devices/{device_id}/schedule

Palauttaa laitteen istuntojen tiedot tietyltä aikaväliltä.

Esimerkki-URL: https://api-testing.yuja.com/services/devices/12345/schedule?startTime=01-08-2021&endTime=07-08-2021

Parametrit:

Esimerkkivastaus:

[
{
"session_name": "First Day",
"isLiveStream": false,
"start_timestamp": 1707856200000,
"session_creator": "Martin Manson",
"owner_id": 374172,
"device_profile": "onestream",
"session_id": 76124,
"duration": "30:10",
"start_time": "Tue Feb 13 20:30:00 UTC 2024",
"session_description": "epiphan",
"repeat_summary": "Does Not Repeat",
"class_name": "Intro to Physics",
"class_code": "2255",
"platform_unique_id": "141070",
"video_id": 1974523
}
]

4.2.7 - POST /services/devices/{device_id}/profiles/create

Luo laitteelle tallennusprofiilin.

Esimerkki-URL-osoite: https://api-testing.yuja.com/services/devices/{device_id}/profiles/create

Parametrit: Pyynnön runko sisältää JSON-taulukon, jonka jokaisessa JSON-objektissa on seuraavat kentät.

Esimerkkipyyntö:

[
{
"profile_id": "456juhgj",
"name": "LiveStreamProfile",
"description": "No desc needed",
"isLiveStream": true
},
{
"profile_id": "789juhgj",
"name": "NormalProfile",
"description": "Normal Profile",
"isLiveStream": false
}
]

Esimerkkivastaus:

{
"success": true,
"profile_ids": [
{
"external_profile_id": "456juhgj",
"yuja_profile_id": 3440
},
{
"external_profile_id": "789juhgj",
"yuja_profile_id": 3441
}
]
}

4.2.8 - POST /services/devices/session

Luo istunto.

Esimerkki-URL-osoite: https://api-testing.yuja.com/services/devices/session

Parametrit:

Esimerkkipyyntö:

{
"start_year":"2021",
"start_month":"10",
"start_day":"7",
"start_hour":"0",
"start_minute":"0",
"duration_hour":"1",
"duration_minute":"30",
"is_live_broadcast":true,
"station_id":"2906",
"login_id":"marythompson",
"session_title":"A Change In The Current Of Microbiology",
"session_description":"Introduction to Microbiology",
"label_colour":“#33AA99”,
"profile_id":“700847”,
"group_id": "216710,216298,216301",
"folderPIDs": "9999909,9973996,10001141,9983955",
"manuallyStartScheduledSession":true,
"usersToSendScheduleCopy":"374971,375097",
"return_session":true,
"createPlaceholder":true
}

Esimerkkivastaus:

{
"success": true,
"sessionDetails": {
"sessionPID": 41194,
"ownerPID": 284667,
"userName": "APITester_NA",
"sessionTitle": "Test session",
"duration": 60,
"startTime": "2021-11-24 13:50:00",
"endTime": "2021-11-24 14:50:00"
}
}

4.2.9 - POST /services/devices/startsession

Käynnistä istunto heti.

Esimerkki-URL-osoite: https://api-testing.yuja.com/services/devices/startsession

Parametrit:

Esimerkkipyyntö:

{
"is_live_broadcast": "true",
"duration_minute": "45"
"station_id": "2906"
"login_id": "marythompson"
"session_title": "A Change In The Current Of Microbiology",
"profile_id": "7008c47"
"storage_path" : "/Sem4/CompScience"
}

4.2.10 - GET/POST /services/devices/{sessionId}/livestream/urls

Päätepiste, joka palauttaa annetun sessionId-tunnuksen suoratoisto-URL-osoitteet ja toisto-URL-osoitteet. Huomaa: ennen API:n käyttöä YuJa Software Capture on rekisteröitävä vyöhykkeellesi.

Pyynnön parametrit:

JSONArray (seuraavan JSON-objektin taulukko) (enintään 3 virtaa sallittu istuntoa kohden)

Esimerkkipyynnön runko:

[
{
"streamName": "stream1",
"streamQuality" : "720",
"videoOnly" : false,
"streamPriority" : "1"
},
{
"streamName": "stream2",
"streamQuality" : "720",
"audioOnly": false,
"videoOnly" : false,
"streamPriority" : "2"
}
]

Esimerkkivastaus:

{
"success": true,
"playbackURL": "https://api-testing.yuja.com/LiveStream/E/37148/1071373286",
"liveStreamDetails": [
{
"streamName": "stream2",
"streamKey": "stream2_34016ce3-1982-4597-802c-90cef0402682_1626897215559",
"liveStreamURL": "rtmp://staging-lc1.yuja.com:1935/rtmp_live?token=adf3086d-b2fd-4369-a992-c3052d42ffc9_1071373286"
},
{
"streamName": "stream1",
"streamKey": "stream1_30613ac6-2cd8-4388-937b-bb2c0c105e1b_1626897215412",
"liveStreamURL": "rtmp://staging-lc1.yuja.com:1935/rtmp_live?token=ee1731b7-9b11-42f5-9e36-2dd5a1316664_1071373286"
}
]
}

4.2.11 - POST /services/devices/stopstation

Pysäytä istunto heti.

Esimerkki-URL-osoite: https://api-testing.yuja.com/services/devices/stopstation

Parametrit:

Esimerkkipyyntö:

{
"device_id": "55492",
"login_id": "marythompson",
}

4.2.12 - POST /services/devices/{device_id}/status (tulossa)

Päätepiste, jolla Luminalle lähetetään säännöllisesti tila- ja lokitietoja. Tähän kuuluvat tarkastuslokit, virhelokit ja hälytykset, kuten heikon mikrofonitason (äänisyötteen) hälytykset.

Esimerkki-URL-osoite: https://api-testing.yuja.com/services/devices/12345/status

Parametrit:

Esimerkkipyyntö:

{
"device_id": 52341,
"timestamp": 2021-05-20 12:00:00,
"type": "status",
}

Esimerkkivastaus:

{
“success”: true
}

4.2.13 - GET /services/devices/session/{session_id}/commands (tulossa)

Asema kysyy Luminalta säännöllisesti taukoon tai pysäytykseen liittyviä komentoja, joita käytetään aktiivisen istunnon hallintaan istunnon aikana. Kyselyväli on tallennusistunnon aikana tiheämpi kuin valmiustilassa. Kyselyn enimmäistiheys ei saa ylittää yhtä kertaa 10 sekunnissa.

Esimerkki-URL-osoite: https://api-testing.yuja.com/services/devices/session/614/commands

Parametrit:

Vastaus:

4.2.14 - DELETE /services/devices/{session_id}

Poista ajastettu istunto.

Esimerkki-URL-osoite: https://api-testing.yuja.com/services/devices/679

Parametrit:

4.2.15 - GET /services/devices/profiles/{device_id}/{login_id}

Hae tietyn käyttäjän profiilit tietyllä laitteella.

Esimerkki-URL-osoite: https://api-testing.yuja.com/services/devices/profiles/12345/loginID123

Parametrit:

Esimerkkivastaus:

{
"profiles":[
{
"profile_name": "rylmao",
"profile_id": "1150"
},
{
"profile_name": "notlive",
"profile_id": "1155"
},
{
"profile_name": "liveoncesource",
"profile_id": "1160"
},
{ "profile_name": "allofthem3sources",
"profile_id": "1164"
},
{
"profile_name": "Audio Only",
"profile_id": "1173"
},
{
"profile_name": "Screen Only",
"profile_id": "1176"
}
]
}

4.2.16 - GET /services/devices/profiles/{device_id}

Hae tietyn käyttäjän profiilit tietyllä laitteella.

Esimerkki-URL-osoite: https://api-testing.yuja.com/services/devices/profiles/12345

Parametrit:

Esimerkkivastaus:

{
"profiles": [
{
"profile_name": "prof1",
"profile_id": "3431",
"external_profile_id": "85693erf"
},
{
"profile_name": "prof2",
"profile_id": "3432",
"external_profile_id": "85693bgh"
}
]
}

4.2.17 - GET /services/devices/userID/{sso}

Hae vastaava userID.

Esimerkki-URL-osoite: https://api-testing.yuja.com/services/devices/userid/testuser

Parametrit:

Esimerkkivastaus:

testuser

4.2.18 - POST /services/devices/editsession

Päivitä istunto annetuilla parametreilla.

Esimerkki-URL-osoite: https://api-testing.yuja.com/services/devices/editsession

Parametrit:

Esimerkkipyyntö:

{
"session_id": ,
"start_year": "2021",
"start_month": "10",
"start_day": "7",
"start_hour": "0",
"start_minute": "0",
"duration_hour": "1",
"duration_minute": "30",
"station_id": "2906",
"login_id": "marythompson",
"session_title": "A Change In The Current Of Microbiology",
"session_description": "Introduction to Microbiology",
"label_colour": "#33AA99",
"profile_id": "<7008c47>"
"storage_path" : "/Sem4/CompScience"
}

4.2.19 - DELETE /services/devices/{device_id}/schedules

Poista kaikki laitteeseen liittyvät ajastetut istunnot.

Esimerkki-URL-osoite: https://api-testing.yuja.com/services/devices/12345/schedules

Parametrit:

4.2.20 - GET /services/devices/{user_id}/sessions

Palauttaa käyttäjän tiedot tietyltä aikaväliltä.

Esimerkki-URL-osoite: https://api-testing.yuja.com/services/devices/marythompson

Parametrit:

Esimerkkivastaus:

[

{

"duration": "0:10",

"session_name": "Chemistry 101 Lecture",

"start_time": "Sun May 10 18:00:00 EDT 2020",

"start_timestamp": 1589148000000,

"session_description": "CHEM 101 Recurring Lecture",

"session_creator": "April Hurst",

"repeat_summary": "Weekly on Sunday for 12 sessions",

"device_profile": "",

"session_id": 1121,

"class_name": "Chemistry 101",

"class_code": "",

"video_id": -1

}

]

4.2.21 - POST /services/devices/{device_id}/status

Päätepiste, jolla YuJa EVP:lle lähetetään säännöllisesti tila- ja lokitietoja.

Parametrit:

Esimerkki-URL-osoite: https://api-testing.yuja.com/services/devices/1480/status

Esimerkkipyynnön runko:

{
"statusType": "DEVICE_STATUS",
"deviceStatus": {
"recording": false,
"uploading": true,
"streaming": false,
"ready": true,
“extra_info”: JSON-objekti, joka sisältää muita hyödyllisiä tietoja, joita ei ole vielä määritetty.
}
}

Esimerkkivastaus:

{
"success": true,
"command": "",
"command_data": ""
}

Huomautus: command ja command_data ovat varauksia tuleville toiminnoille, joilla laitteita ohjataan, kuten mahdollisuus kehottaa laitteita keskeyttämään tai päättämään istunto portaalistamme.

4.2.22 - POST /services/devices/yujahardware/{device_id}/profiles/create

Päätepiste hub-profiilien luomiseen.

Esimerkki-URL: https://api-testing.yuja.com/services/devices/yujahardware/{device_id}/profiles/create

Parametrit:

Esimerkkipyynnön runko:

[{
"Name": "1",
"Description": "",
"MediaDevice0": true,
"MediaDevice1": false,
"MediaDevice2": false,
"LineInAudio": true
}]

Esimerkkivastaus:

{"error_message":"","success":true,"profiles":[{"profile_name":"1","profile_id":"3313"}]}

4.2.23 - PUT /services/devices/yujahardware/{device_id}/profiles/update

Päätepiste hub-profiilin päivittämiseen.

Esimerkki-URL: https://api-testing.yuja.com/services/devices/yujahardware/{device_id}/profiles/update

Parametrit:

Esimerkkipyynnön runko:
{
"ProfilePID": 3217,
"Name":"Test Update",
"Description": "A capture profile containing 1 video stream and 1 audio stream",
"MediaDevice0": false,
"MediaDevice1": true,
"MediaDevice2": false,
"LineInAudio": true
}
Esimerkkivastaus:
{
"errorMessage": "",
"success": true
}

4.2.24 - DELETE /services/devices/yujahardware/{device_id}/profiles/{profile_id}/delete

Päätepiste hub-profiilin poistamiseen.

Esimerkki-URL:

https://api-testing.yuja.com/services/devices/yujahardware/{device_id}/profiles/{profile_id}/delete

Parametrit:

Esimerkkivastaus:

{ "errorMessage": "",
"success": true
}

4.2.25 - GET /services/devices/{deviceId}/profiles/{externalProfileId}

Palauttaa YuJa:n profiilitunnuksen annettua ulkoista profiilitunnusta vastaan.

Esimerkki-URL: https://api-testing.yuja.com/services/devices/1543/profiles/external/wstestprofile

Parametrit:

Esimerkkivastaus:

{
"profile_Id": "wstestprofile",
"yuja_profile_Id": 3412
}

4.2.26 - DELETE /services/devices/unregister/{deviceId}

Poistaa minkä tahansa rekisteröidyn laitteen.

Esimerkki-URL: https://api-testing.yuja.com/services/devices/unregister/1547

Parametrit:

Esimerkkivastaus:

{
"success": true
}

4.2.27 - PUT /services/devices/{sessionId}/extend

Pidentää kolmannen osapuolen laitteiden istunnon kestoa (oletuksena 30 minuutilla).

Esimerkki-URL: https://api-testing.yuja.com/services/devices/38957/extend?minutes=6

Parametrit:

Esimerkkivastaus:

{
"success": true,
"message": "Successfully extended session for 6 minutes"
}

4.2.28 - GET - /services/devices/{deviceId}/{profileId}/previewlinks

Palauttaa esiallekirjoitetut S3-URL-osoitteet, joilla ääni- ja kuvaesikatselut voidaan päivittää.

Esimerkki-URL: https://api-testing.yuja.com/services/devices/1480/3431/previewlinks?videoStream=1&audioStream=1

Parametrit:

Esimerkkivastaus:

{
"audios": [
{
"audioJsonURL":
"https://yuja-device-thumbnail.s3.amazonaws.com/sanchitbig2-epiphansanchitprof1-audio-0.json?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEM%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLXdlc3QtMSJHMEUCIDhdEg115WlmnSKN8uqgmgL%2BDOcee6x6RSmE3OoMH22IAiEAwaFQQ4TbarjWBCvdVj1lS5JBs08IeNyIhMkhU%2FenksIq%2BgMISBAAGgw2MzE5OTkzNDU1OTMiDG9nrti1XJHkrtrKJyrXA2er1rESVKfXjPXRTrn7nLqbpFQ6uXyC2ajQMiNsQl8OMN5zcE04YXQeIrnnB6FweDvD00f7xIzHoB6w%2Fk1pkxmA%2FN%2BvJuPjeUVeIs1qy6Ksv1C5pR1Ua9HGg56lLuVxmit0jn5VWWaFkF9fzSBNX9g6ZeexKnQOUjMvYUxnTbyL0S3Tb0gEumIwf7L%2Fm5zQgqVoH4RQaSofmOVKc2sFrgi%2BwjyPC9BmB1XzairI7MasbfWZqNlCu%2BrG5HAv7TcA1aPeJ%2BbWxh8XkTKf3P%2B1xXjsTOxcHWjJCDnyLJ7dNfkNe1D2QV8c9wb2Bs98%2B2zEPuIFr%2FlQXYwuROjSVMk3QU714cF09q8W5jwwjSFQJedWfBwQrmEGNzg2CbM5gbJPh%2BLuuUkWZ78Y0xL1rMWQgK2Fd3OXWdqkWqgVbhTm%2FOalftwQ7GLD9WElErRLYz1OKPp2UpESpIrJd8B%2BVDFeBxlF3Zdums9yKhW4xBK8sDaXyna8DvlwtJqvo3pNQjjm4%2FJHwYgz32parf%2Fc6v7sgcXeEt2Rh7yQ8D8RanVqFzElhbg0IVoaU7RlQaLJXwtf1Ofkdbn%2FhwKZ8jRmAsM3FfkK97bkmOTZYGBniGMjvarXMoNP3EhAizCJqOyKBjqlAfeQJq5Prq3TBXA0fd4wA2sAHAstHfN6PKjnllZahJj04r4a5NQqG4NxLgX4XbpInydKijLCSFfRwtgi1ar6I5EMJG23hZwhIbg2%2FR1crTUcUZ7PxPfsGLtxnpaco%2FIImR1ljNA6z9fs4iq%2F4TxUKNRQpIBgqqIScGq0dqFF1CRnROW8ptmv1zTotHHtLIBabWPT9RjwgAuSGfOLyG7DYmAj%2Fa6Q8Q%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20211004T153617Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAZGJQYWO42OPAIK5Z%2F20211004%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=29ff5b318d3e7032e9f460680e8325bb94d8f81118057f6c3c9c7bdd9bcb46fb", "audioMp4URL":
"https://yuja-device-thumbnail.s3.amazonaws.com/sanchitbig2-epiphansanchitprof1-audio-0.mp4?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEM%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLXdlc3QtMSJHMEUCIDhdEg115WlmnSKN8uqgmgL%2BDOcee6x6RSmE3OoMH22IAiEAwaFQQ4TbarjWBCvdVj1lS5JBs08IeNyIhMkhU%2FenksIq%2BgMISBAAGgw2MzE5OTkzNDU1OTMiDG9nrti1XJHkrtrKJyrXA2er1rESVKfXjPXRTrn7nLqbpFQ6uXyC2ajQMiNsQl8OMN5zcE04YXQeIrnnB6FweDvD00f7xIzHoB6w%2Fk1pkxmA%2FN%2BvJuPjeUVeIs1qy6Ksv1C5pR1Ua9HGg56lLuVxmit0jn5VWWaFkF9fzSBNX9g6ZeexKnQOUjMvYUxnTbyL0S3Tb0gEumIwf7L%2Fm5zQgqVoH4RQaSofmOVKc2sFrgi%2BwjyPC9BmB1XzairI7MasbfWZqNlCu%2BrG5HAv7TcA1aPeJ%2BbWxh8XkTKf3P%2B1xXjsTOxcHWjJCDnyLJ7dNfkNe1D2QV8c9wb2Bs98%2B2zEPuIFr%2FlQXYwuROjSVMk3QU714cF09q8W5jwwjSFQJedWfBwQrmEGNzg2CbM5gbJPh%2BLuuUkWZ78Y0xL1rMWQgK2Fd3OXWdqkWqgVbhTm%2FOalftwQ7GLD9WElErRLYz1OKPp2UpESpIrJd8B%2BVDFeBxlF3Zdums9yKhW4xBK8sDaXyna8DvlwtJqvo3pNQjjm4%2FJHwYgz32parf%2Fc6v7sgcXeEt2Rh7yQ8D8RanVqFzElhbg0IVoaU7RlQaLJXwtf1Ofkdbn%2FhwKZ8jRmAsM3FfkK97bkmOTZYGBniGMjvarXMoNP3EhAizCJqOyKBjqlAfeQJq5Prq3TBXA0fd4wA2sAHAstHfN6PKjnllZahJj04r4a5NQqG4NxLgX4XbpInydKijLCSFfRwtgi1ar6I5EMJG23hZwhIbg2%2FR1crTUcUZ7PxPfsGLtxnpaco%2FIImR1ljNA6z9fs4iq%2F4TxUKNRQpIBgqqIScGq0dqFF1CRnROW8ptmv1zTotHHtLIBabWPT9RjwgAuSGfOLyG7DYmAj%2Fa6Q8Q%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20211004T153617Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAZGJQYWO42OPAIK5Z%2F20211004%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=ff843f683a0b01aa09b4c96c443a6e80f7b30f476397a234b578dc1e2dbd4cc1" }
],
"deviceId": 1480,
"images": [
"https://yuja-device-thumbnail.s3.amazonaws.com/sanchitbig2-epiphansanchitprof1-img-0?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEM%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLXdlc3QtMSJHMEUCIDhdEg115WlmnSKN8uqgmgL%2BDOcee6x6RSmE3OoMH22IAiEAwaFQQ4TbarjWBCvdVj1lS5JBs08IeNyIhMkhU%2FenksIq%2BgMISBAAGgw2MzE5OTkzNDU1OTMiDG9nrti1XJHkrtrKJyrXA2er1rESVKfXjPXRTrn7nLqbpFQ6uXyC2ajQMiNsQl8OMN5zcE04YXQeIrnnB6FweDvD00f7xIzHoB6w%2Fk1pkxmA%2FN%2BvJuPjeUVeIs1qy6Ksv1C5pR1Ua9HGg56lLuVxmit0jn5VWWaFkF9fzSBNX9g6ZeexKnQOUjMvYUxnTbyL0S3Tb0gEumIwf7L%2Fm5zQgqVoH4RQaSofmOVKc2sFrgi%2BwjyPC9BmB1XzairI7MasbfWZqNlCu%2BrG5HAv7TcA1aPeJ%2BbWxh8XkTKf3P%2B1xXjsTOxcHWjJCDnyLJ7dNfkNe1D2QV8c9wb2Bs98%2B2zEPuIFr%2FlQXYwuROjSVMk3QU714cF09q8W5jwwjSFQJedWfBwQrmEGNzg2CbM5gbJPh%2BLuuUkWZ78Y0xL1rMWQgK2Fd3OXWdqkWqgVbhTm%2FOalftwQ7GLD9WElErRLYz1OKPp2UpESpIrJd8B%2BVDFeBxlF3Zdums9yKhW4xBK8sDaXyna8DvlwtJqvo3pNQjjm4%2FJHwYgz32parf%2Fc6v7sgcXeEt2Rh7yQ8D8RanVqFzElhbg0IVoaU7RlQaLJXwtf1Ofkdbn%2FhwKZ8jRmAsM3FfkK97bkmOTZYGBniGMjvarXMoNP3EhAizCJqOyKBjqlAfeQJq5Prq3TBXA0fd4wA2sAHAstHfN6PKjnllZahJj04r4a5NQqG4NxLgX4XbpInydKijLCSFfRwtgi1ar6I5EMJG23hZwhIbg2%2FR1crTUcUZ7PxPfsGLtxnpaco%2FIImR1ljNA6z9fs4iq%2F4TxUKNRQpIBgqqIScGq0dqFF1CRnROW8ptmv1zTotHHtLIBabWPT9RjwgAuSGfOLyG7DYmAj%2Fa6Q8Q%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20211004T153617Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAZGJQYWO42OPAIK5Z%2F20211004%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=18898f478edf1505c71ea25f287dd6fea5bb252fd240616cb3d2c0c760bbfccc" ],
"success": true,
"yujaProfileId": 3431
}

4.2.29 - PUT - /services/devices/{sessionId}/stop

Pysäyttää kolmannen osapuolen laitteiden istunnon välittömästi

Esimerkki-URL: https://api-testing.yuja.com/services/devices/38957/stop

Parametrit:

Esimerkkivastaus:

{
"success": true,
"message": "Successfully stopped the session"
}

4.2.30 - POST - /services/devices/session/{sessionPId}/pause

Keskeyttää tietyn istunnon suoratoiston toiston.

Esimerkki-URL: https://api-testing.yuja.com/services/devices/session/38519/pause

Parametrit:

Esimerkkivastaus:

{
"success": true
}

4.2.31 - POST - /services/devices/session/{sessionPId}/resume

Jatkaa tietyn istunnon suoratoiston toistoa.

Esimerkki-URL: https://api-testing.yuja.com/services/devices/session/38519/resume

Parametrit:

Esimerkkivastaus:

{
"success": true
}

4.2.32 - DELETE /services/devices/{deviceId}/profiles/thirdParty/{yujaProfileId}

Poistaa kolmannen osapuolen profiilit.

Parametrit:

Esimerkkivastaus:

{
"success": true,
"message": "Profile Deleted Successfully!"
}

4.2.33 - PUT /services/devices/{deviceId}/profiles/thirdParty/{yujaProfileId}

Päivittää kolmannen osapuolen profiilien tiedot.

Parametrit:

Esimerkkipyynnön runko:

{
"profile_id": "456juhgj",
"Name": "LiveStreamProfile",
"description": "No desc needed",
"isLiveStream": true
}

Esimerkkivastaus:

{
"success": true,
"message": "Profile Updated Successfully!"
}

4.2.34 - GET /services/devices/{deviceId}/{yujaProfileId}/previewURLs

Palauttaa annetun laitteen ja sitä vastaavan profiilin video- ja ääniesikatselun URL-osoitteet.

Parametrit:

Esimerkkivastaus:

{
"videoPreviewURLs": [
{
"headUrl": "https://yuja-device-thumbnail.s3.amazonaws.com/1bb8f4f8-dc6b-43bb-b2ce-a616acb5e760-screen-0?ClassPID=0&response-content-disposition=attachment%3B%20filename%3D%22preview.jpg%22&response-content-type=application%2Foctet-stream&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220118T170342Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAZGJQYWO4SSYZXBEL%2F20220118%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=53f08cfef1c28a31ba28b5266146b8a17be1de94b67c03cbae652792b548e685",
"url": "https://yuja-device-thumbnail.s3.amazonaws.com/1bb8f4f8-dc6b-43bb-b2ce-a616acb5e760-screen-0?ClassPID=0&response-content-disposition=attachment%3B%20filename%3D%22preview.jpg%22&response-content-type=application%2Foctet-stream&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220118T170340Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAZGJQYWO4SSYZXBEL%2F20220118%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=aca44942c4f693032751287ccbbf5f362474d834462976cf2558b70641816544"
}
],
"audioPreviewURLs": [
{
"headUrl": "https://yuja-device-thumbnail.s3.amazonaws.com/1bb8f4f8-dc6b-43bb-b2ce-a616acb5e760MicrophoneMpowHC.mp4?ClassPID=0&response-content-disposition=attachment%3B%20filename%3D%22preview.mp4%22&response-content-type=video%2Fmp4&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220118T170342Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAZGJQYWO4SSYZXBEL%2F20220118%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2522d8969ecb46eb400d74c12520dc35301274bcba49de3ec92cb50e0a3729e3",
"url": "https://yuja-device-thumbnail.s3.amazonaws.com/1bb8f4f8-dc6b-43bb-b2ce-a616acb5e760MicrophoneMpowHC.mp4?ClassPID=0&response-content-disposition=attachment%3B%20filename%3D%22preview.json%22&response-content-type=application%2Fjson&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220118T170340Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAZGJQYWO4SSYZXBEL%2F20220118%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=e936ec2e95203c3cddf68cf7bce02490a615613429c6c3dc05c164f8a4fd36b1"
}
],
"audioJsonURLs": [
{
"headUrl": "https://yuja-device-thumbnail.s3.amazonaws.com/1bb8f4f8-dc6b-43bb-b2ce-a616acb5e760MicrophoneMpowHC.json?ClassPID=0&response-content-disposition=attachment%3B%20filename%3D%22preview.json%22&response-content-type=application%2Fjson&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220118T170342Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAZGJQYWO4SSYZXBEL%2F20220118%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=64f515d41b9c61f4241e0db97d12a373de872612284b1a45c4f81530d56955da",
"url": "https://yuja-device-thumbnail.s3.amazonaws.com/1bb8f4f8-dc6b-43bb-b2ce-a616acb5e760MicrophoneMpowHC.json?ClassPID=0&response-content-disposition=attachment%3B%20filename%3D%22preview.json%22&response-content-type=application%2Fjson&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220118T170340Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAZGJQYWO4SSYZXBEL%2F20220118%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=241384d39d8953c32c4d16f2ee9ebbd83dfc1441a0c091d8e10de2f6f35dcff5"
}
]
}

4.2.35 - GET /services/devices/{deviceId}/status

Palauttaa rekisteröityjen YSC-asemien laitetilat.

Parametrit:

Esimerkkivastaus:

{
"connected": true,
"streaming": false,
"ready": true,
"access_id": "presenter-service-1bb8f4f8-dc6b-43bb-b2ce-asdvsadfvf",
"recording": false,
"uploading": false
}

5 - Media-rajapinnan yleiskatsaus

Media​ kattaa kaikki oppilaitoksen aineistot. Näihin kuuluvat äänitiedostot, videotiedostot ja muut asiakirjat.

5.1 - Median objektimalli

5.2 - Pääpäätepisteet

5.2.1 - GET /services/createuploadlink

Palauttaa JSON-objektin, joka sisältää lähetyslinkin ja file_key-arvon. Voit lähettää videon S3:een tekemällä HTTP PUT -pyynnön käyttäen palautettua lähetyslinkkiä kohteena ja liittämällä pyyntöön videotiedoston.

Esimerkki-URL: https://api-testing.yuja.com/services/media/createuploadlink

Parametrit:

Tämä kutsu ei tarvitse parametreja.

Esimerkkivastaus:

[
{
​"url​": "<upload_link>",
"​key​": "<key>"
}
]

5.2.2 - POST /services/upload/video/

Lähettää videon sen käyttäjän mediakirjastoon, jonka login_id vastaa runkoparametrin arvoa.

Esimerkki-URL: https://api-testing.yuja.com/services/media/upload/video/

Parametrit:

5.2.3 - POST /services/publish/video/

Julkaisee käyttäjän (login_id) omistaman videon ryhmässä, jonka group_id vastaa runkoparametrin arvoa.

Esimerkki-URL: https://api-testing.yuja.com/services/media/publish/video

Parametrit:

5.2.4 - GET /services/video/group/{group_id}

Palauttaa JSON-objektin, joka sisältää kurssin videoiden tiedot.

Esimerkki-URL: https://api-testing.yuja.com/services/media/video/group/121

Parametrit:

Esimerkkivastaus:

{
"description": " uploaded by abcd",
"title": "avi_test1",
"video_id": "67890"
},
{
"description": " uploaded by pqrs",
"title": "flv_test1",
"video_id": "67891"
}

5.2.5 - GET /services/video/directlink/{video_id}

Palauttaa JSON-objektin, joka sisältää videon suoran linkin ja upotuskoodin.

Esimerkki-URL: https://api-testing.yuja.com/services/media/video/directlink/67890

Parametrit:

Esimerkkivastaus:

{
"​directlink​": "<Direct link to the video>",
"​embedcode​": "<The embedded code for the video>"
}

5.2.6 - POST /services/replace/video/

Korvaa käyttäjän (login_id) omistaman videon toisella videolla.

Esimerkki-URL: https://api-testing.yuja.com/services/media/replace/video

Parametrit:

5.2.7 - GET /services/retrievebranding

Palauttaa JSON-objektin, joka sisältää organisaation mediasoittimen brändäystiedot.

Esimerkki-URL: https://api-testing.yuja.com/services/media/retrievebranding

Parametrit:

Tämä kutsu ei vaadi parametreja.

Esimerkkivastaus:

{
"button_color": "#ffffff",
"setting_menu_color": "#011100",
"sidebar_color": "#ABCDEF",
"setting_text_color": "#ffffff"
}

5.2.8 - PUT /services/updatebranding/

Päivittää organisaation mediasoittimen brändäystiedot.

Esimerkki-URL: https://api-testing.yuja.com/services/media/updatebranding

Parametrit:

5.2.9 - GET /services/retrieveuserassets/{login_id}

Palauttaa JSON-objektin, joka sisältää kurssin videoiden tiedot.

Esimerkki-URL: https://api-testing.yuja.com/services/media/retrieveuserassets/marythompson

Parametrit:

Esimerkkivastaus:

{
{
"Asset_type": "Folder",
"folder_id": 45621,
"title": "New Folder"
},
{
"Asset_type": "Video File",
"title": "Hello World",
"video_id": 12345
}
}

5.2.10 - POST /services/media/upload/session/{session_id}/createlinks

Luo lähetyslinkit istunnon tallenteiden lähettämistä varten.

Esimerkki-URL: https://api-testing.yuja.com/services/media/upload/session/619/createlinks

Parametrit:

video_sources-kentät:

pause_timestamps-kentät:

Esimerkkipyyntö:

{
"video_sources": [{
"stream_type": "videoCapture",
"stream_id": "Gv9U5qvNpR"
},{
"stream_type": "screenCapture",
"stream_id": "vKYrIkpqp2",
}],
"pause_timestamps": [{
"pause_timestamp": 5000,
"resume_timestamp": 10000
}]
}

Esimerkkivastaus:

{
upload_urls: [
{
stream_id: string,
url: string
}, {...}]
}

5.2.11 - POST /services/media/upload/session/{session_id}

Ilmoittaa, että tallenteen lähettäminen S3-URL-osoitteisiin on valmis ja että videon käsittely tulee aloittaa.

Esimerkki-URL: https://api-testing.yuja.com/services/media/upload/session/1234

Parametrit:

Esimerkkivastaus:

{
“success”: true
}

5.2.12 - GET /services/media/metadata/{video_id}

Hakee kaikki annettuun video_id-arvoon liittyvät metatietomerkinnät.

Esimerkki-URL: https://api-testing.yuja.com/services/media/metadata/187195

Parametrit:

Esimerkkivastaus:

[
{
"Name": "PhyExam",
"Type": "Date",
"Value": "Thu May 20 00:00:00
EDT 2021"
},
{
"Name": "ChemExam",
"Type": "String",
"Value": "Chemistry"
}
]

5.2.13 - POST /services/media/metadata/{video_id}

Lisää kaikki annettuun video_id-arvoon liittyvät metatietomerkinnät.

Esimerkki-URL: https://api-testing.yuja.com/services/media/metadata/187195

Parametrit:

newMetadata-kentät:

Esimerkki pyynnön runkoparametreista:
{
newMetadata: [
{
"Name": "PhyExam",
"Type": "String",
"Value": "Easy"
},
{
"Name": "ChemExam",
"Type": "Date",
"Value": "05/05/2021"
}
]
}

Esimerkkivastaus:

"Successfully Inserted 1 record/s in to the database !!!"

5.2.14 - DELETE /services/media/metadata/{video_id}

Poistaa kaikki annettuun video_id-arvoon ja annettuun metatietojen nimien luetteloon liittyvät metatietomerkinnät.

Esimerkki-URL: https://api-testing.yuja.com/services/media/metadata/187195

Parametrit:

Esimerkki pyynnön runkoparametreista:

[
"PhyExam",
"ChemExam"
]

Esimerkkivastaus:

"Successfully Deleted 2 record/s form the database !!!"

5.2.15 - GET /services/media/searchVideo

Hakee kaikki videot runkoparametrissa annettujen hakuehtojen mukaan.

Esimerkki-URL: https://api-testing.com/services/media/searchVideo

Parametrit:

Esimerkki pyynnön runkoparametreista:
{
"searchString": "Polish",
"searchAs": "John_ITManager",
"searchInMediaContent": "false",
"ownerId": "",
"createdBefore": "",
"createdAfter": "",
"tag":"",
"metadata": ""
}

Esimerkkivastaus:

[
{
"videoPID": 187126,
"videoTitle": "Polish capt",
"videoDesc": "",
"ownerName": "john_itmanager",
"directLink":
"https://localhost.yuja.com/V/Video?v=187126&node=9388965&a=1581885302&autoPlay=1",
embedCode": "<iframe width='560'height= '315' src=
'https://localhost.yuja.com/V/Video?v=187126&node=9388965&a=1581885302'frameborder= '0'
webkitallowfullscreen mozallowfullscreen allowfullscreen allow=’autoplay’></iframe>",
"duration": "584.006",
"createdDate": "2021-04-30 16:19:39",
"contentFoundInMedia": false
},
{
"videoPID": 188016,
"videoTitle": "Polish capt",
"videoDesc": "",
"ownerName": "john_itmanager",
"directLink":
"https://localhost.yuja.com/V/Video?v=187126&node=9388965&a=1581885302&autoPlay=1",
"embedCode": "<iframe width='560'height= '315' src=
'https://localhost.yuja.com/V/Video?v=187126&node=9388965&a=1581885302'frameborder= '0'
webkitallowfullscreen mozallowfullscreen allowfullscreen allow=’autoplay’></iframe>",
"duration": "584.006",
"createdDate": "2021-05-06 11:49:52",
"contentFoundInMedia": false
}
]

5.2.16 - GET /services/media/searchVideoWithQueryString

Hakee kaikki videot kyselyparametreissa annettujen hakuehtojen mukaan.

Esimerkki-URL: https://api-testing.com/services/media/searchVideoWithQueryString?searchString=Polish&searchAs=John_ITManager

Parametrit:

Esimerkkivastaus:

[
{
"videoPID": 187126,
"videoTitle": "Polish capt",
"videoDesc": "",
"ownerName": "john_itmanager",
"directLink":
"https://localhost.yuja.com/V/Video?v=187126&node=9388965&a=1581885302&autoPlay=1",
"embedCode": "<iframe width='560'height= '315' src=
'https://localhost.yuja.com/V/Video?v=187126&node=9388965&a=1581885302'frameborder= '0'
webkitallowfullscreen mozallowfullscreen allowfullscreen allow=’autoplay’></iframe>",
"duration": "584.006",
"createdDate": "2021-04-30 16:19:39",
"contentFoundInMedia": false
},
{
"videoPID": 188016,
"videoTitle": "Polish capt",
"videoDesc": "",
"ownerName": "john_itmanager",
"directLink":
"https://localhost.yuja.com/V/Video?v=187126&node=9388965&a=1581885302&autoPlay=1",
"embedCode": "<iframe width='560'height= '315' src=
'https://localhost.yuja.com/V/Video?v=187126&node=9388965&a=1581885302'frameborder= '0'
webkitallowfullscreen mozallowfullscreen allowfullscreen allow=’autoplay’></iframe>",
"duration": "584.006",
"createdDate": "2021-05-06 11:49:52",
"contentFoundInMedia": false
}
]

5.2.17 - Julkaistut käsittelijät

Kuuntelemme postMessage-tapahtumaa, joka välittää JSON-parametrin.

Tapahtumaparametrit:

Esimerkki JSON-parametrista:

var pass_data = {
'name':’AdjustVolume’,
‘value’: ‘50’
};
document.getElementById('yujaIFrame').contentWindow.postMessage(JSON.stringify(pass_data),"*");

5.2.18 - GET /services/media/folders/user_id

Hakee kaikki kansiot, joihin käyttäjällä on pääsy YuJassa annetun user_id-arvon perusteella.

Esimerkki-URL: https://api-testing.com/services/media/folders/john_manager

Parametrit:

Esimerkkivastaus:

[
{
"directLink": "https://api-testing.yuja.com/V/Video?v=186622&node=&a=1121111456&autoPlay=1",
"embedCode": "<iframe width='560' height= '315' src=
'https://api-testing.yuja.com/V/Video?v=186622&node=&a=1121111465' frameborder= '0' webkitallowfullscreen
mozallowfullscreen allowfullscreen allow='autoplay'></iframe>",
"folderPID": 9385799,
"folderTitle": "My Media Collections",
"folderVideosCount": 15
},
{
"directLink": "https://api-testing.yuja.com/V/Video?v=186643&node=&a=1121111648&autoPlay=1",
"embedCode": "<iframe width='560' height= '315' src= 'https://api-testing.yuja.com/V/Video?v=186643&node=&a=1121111648' frameborder= '0' webkitallowfullscreen mozallowfullscreen allowfullscreen allow='autoplay'></iframe>",
"folderPID": 9385801,
"folderTitle": "Shared With Me",
"folderVideosCount": 0
}
]

5.2.19 - GET /services/media/videos/user/user_id

Hakee kaikki videot, joihin käyttäjällä on pääsy YuJassa annetun user_id-arvon perusteella.

Esimerkki-URL: https://api-testing.com/services/media/videos/user/john_manager

Parametrit:

Esimerkkivastaus:

[
{
"videoPID": 186643,
"videoTitle": "Ted Talk",
"videoDesc": "",
"ownerName": "john_manager",
"directLink": "https://api-testing.yuja.com/V/Video?v=186643&node=&a=1121111648&autoPlay=1",
"embedCode": "<iframe width='560' height= '315' src=
'https://api-testing.yuja.com/V/Video?v=186643&node=&a=1121111648' frameborder= '0' webkitallowfullscreen
mozallowfullscreen allowfullscreen allow='autoplay'></iframe>",
"duration": "146.0",
"createdDate": "2021-04-28 10:05:27",
"contentFoundInMedia": false },
{
"videoPID": 187118,
"videoTitle": "Learn English",
"videoDesc": "",
"ownerName": "john_manager",
"directLink": "https://api-testing.yuja.com/V/Video?v=187118&node=&a=1616050998&autoPlay=1",
"embedCode": "<iframe width='560' height= '315' src=
'https://api-testing.yuja.com/V/Video?v=187118&node=&a=1616050998' frameborder= '0' webkitallowfullscreen
mozallowfullscreen allowfullscreen allow='autoplay'></iframe>",
"duration": "194.282",
"createdDate": "2021-04-30 15:32:37",
"contentFoundInMedia": false
}
]

5.2.20 - GET /services/media/videos/user_id/folder_id

Hakee tietyn kansion videot, joihin käyttäjällä on pääsy YuJassa.

Esimerkki-URL: https://api-testing.com/services/media/videos/john_manager/9385800

Parametrit:

Esimerkkivastaus:

{
"directLink": "https://api-testing.yuja.com/V/Video?v=184543&node=&a=1121111423&autoPlay=1",
"embedCode": "<iframe width='560' height= '315' src= 'https://api-testing.yuja.com/V/Video?v=184543&node=&a=1121111423' frameborder= '0' webkitallowfullscreen mozallowfullscreen allowfullscreen allow='autoplay'></iframe>","folderPID": 9385800,
"folderTitle": "Default Collection",
"folderVideosCount": 1,
"videos": [
{
"videoPID": 188166,
"videoTitle": "Ted Talk",
"videoDesc": "",
"ownerName": "john_manager",
"directLink": "https://api-testing.yuja.com/V/Video?v=188166&node=&a=814045209&autoPlay=1",
"embedCode": "<iframe width='560' height= '315' src=
'https://api-testing.yuja.com/V/Video?v=188166&node=&a=814045209' frameborder= '0' webkitallowfullscreen
mozallowfullscreen allowfullscreen allow='autoplay'></iframe>",
"duration": "584.006",
"createdDate": "2021-05-07 15:15:19",
"contentFoundInMedia": false
}
]
{

5.2.21 - GET /services/media/videos/video_id

Hakee kaikki videot kyselyparametreissa annettujen hakuehtojen mukaan.

Esimerkki-URL: https://api-testing.com/services/media/videos/video_id

Parametrit:

Esimerkkivastaus:

[
{
"videoPID": 187195,
"videoTitle": "Learn English",
"videoDesc": "",
"ownerName": "john_manager",
"directLink":
"https://api-testing.yuja.com/V/Video?v=187126&node=9388965&a=1581885302&autoPlay=1",
"embedCode": "<iframe width='560' height= '315' src=
'https://api-testing.yuja.com/V/Video?v=187126&node=9388965&a=1581885302' frameborder= '0'
webkitallowfullscreen mozallowfullscreen allowfullscreen allow=’autoplay’></iframe>",
"duration": "584.006",
"createdDate": "2021-04-30 16:19:39",
"contentFoundInMedia": false
}
]

5.2.22 - GET /services/media/videos/{videoPId}/streams/hls

Palauttaa HLS-virrat sekä muut videoon liittyvät tärkeät tiedot.

Parametrit:

Esimerkkivastaus:
{
"success": true,
"streams": [
{
"typeAndVideoSourceMap": {
"MP4": {
"streamName": "torontobig2QP0203PCI1",
"fileURL": "https://dtafh6l1ipq5n.cloudfront.net/lcd42SVbjcZ_toronto-big-2-QP0203PCI1_append.mp4?ClassPID=0&response-content-disposition=attachment%3B%20filename%3D&Expires=1628261919&Signature=iHM-DJhekk4HmS36oHlg3MuRIpw~DRFSlkWC6C6UAAHIG3JQvQw7ERc1ckFDJ1VvkZmjbhtz9EKbzQ44hU4J0-zQwg9WBB1y~IZBzMCLBB-H0Vb6DC9YdRQ1c3E8Xm4DmBbdLv6qrjdlot6U3AtRsBU4pySrU7-XpRC1u3fL4Pah9Bx-GSXru3vz2UaF9PJSMr0Ip43nbkwigBUGP3innbAfONRZ3WN4oXoXXqjUmImjwE84JWFtYWTpl6hZwevYzVIgp9uoPnCPMJh20xbHH~jaeb8rcAnuJXOTaOEvN71yq4eeOsIOnhZ6yDtkteVs42IdWoaPrf44lB9DmNf1Kw__&Key-Pair-Id=APKAIXVPTKJJZUC2WWIA", "offset": 1061,
"timestamp": 1628109498455,
"streamType": "MP4",
"cloudFrontURL": ""
},
"HLS": {
"streamName": "torontobig2QP0203PCI1",
"fileURL": "/P/Data/VideoUrl/lcd42SVbjcZ_torontobig2QP0203PCI1_appendmp4_-index.m3u8?dist=staging-hub-video&key=lcd42SVbjcZ_toronto-big-2-QP0203PCI1_append.mp4_hls/index.m3u8&classPID=0&cookie=false", "offset": 1061,
"timestamp": 1628109498455,
"streamType": "HLS",
"cloudFrontURL": "https://dtafh6l1ipq5n.cloudfront.net/P/Data/VideoUrl/lcd42SVbjcZ_torontobig2QP0203PCI1_appendmp4_-index.m3u8?dist=staging-hub-video&key=lcd42SVbjcZ_toronto-big-2-QP0203PCI1_append.mp4_hls/index.m3u8&classPID=0&cookie=true" }
},
"isAudioOnly": false,
"streamName": "torontobig2QP0203PCI1",
"isScreenCapture": false
}
],
"captionURL": {
"English": "/P/DataPage/CaptionFile/183732_English.srt",
"English_ConfScore": "https://staging-caption.s3.us-west-1.amazonaws.com/183732_English_ConfScore.txt?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEC4aCXVzLWVhc3QtMSJGMEQCIB5UE2AThxBH%2B4sUpqiFgd7%2BuGEWuWhoY1c8uhhd3NG7AiBxZMKNCh3ZORLnC8gI4PnyXC%2Bthcw87zYV6X9Sn9yiQSrvAQhHEAAaDDYzMTk5OTM0NTU5MyIMM1J4miNUMy7mV%2F1NKswBa%2BC5eisKYAqjGKPjEbTUIEwZMyRcraPABvSlBuhuw1iXXz07YRG6e0yJi1qfO3C02wb%2B3lcorHqlThGgAziUMTEOz%2FYFDJFqhr4p0Gn9PBhemIELA7jRPaBU0YsCmWqwH%2BQTBMm91M2joil7EyK7H0x8MlxJB4HbU3D1%2FUGIeoPiYEPiYH3axOUJlaCJd73k86FJrWRw1DnB%2BifREob%2FD4Zcy2THbHwuINNn5IPncO7aCtVKkNzcjtw7%2FA6Up5hJez4M4Z55BxTeB2jEMOHXr4gGOpkBruyB%2Bh%2FgrMuPzpqPFNWyZRgDbWbdFR5lGHSKHhOIOCWE0VcXXvuO0pDBPtPy1WJxDl%2FqOuQs64AFtDB7fLJpGg55h0Y72Fbc3PUNb4jWVkWtl4sHoZys21ecN8WVyc5aTC6TZ2fKmfK2D5HkpQKtxJdnsx9IELd9llk2lBgaTJdrdkJKqJhqoYgzgRKcklRwQlw2Nbwz9hU3&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210805T145838Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86399&X-Amz-Credential=ASIAZGJQYWO4UQVXAUUZ%2F20210805%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Signature=234ba10c282b8d96584ced3fb7c619604f758a4df94fa6a3d2e41a42903f5561" }
}

5.2.23 - GET /services/media/videos/{videoPId}/streams/thumbnail

Palauttaa pikkukuvien URL-osoitteet sekä muut videota koskevat tärkeät tiedot.

Parametrit:

Esimerkkivastaus:

{
"success": true,
"streams": [
{
"isAudioOnly": false,
"streamName": "Video-40d36c8a-1382-4cac-a755-3e34c4cd4918_processed.mp4",
"isScreenCapture": false,
"thumbnailList": [
{
"url": "https://staging-video-thumbnail.s3.amazonaws.com/Video-40d36c8a-1382-4cac-a755-3e34c4cd4918_processed_medium_0001.jpg",
"timestamp": 0
},
{
"url": "https://staging-video-thumbnail.s3.amazonaws.com/Video-40d36c8a-1382-4cac-a755-3e34c4cd4918_processed_medium_0071.jpg",
"timestamp": 349368
}
]
}
],
"captionURL": {
"Italian": "/P/DataPage/CaptionFile/184088_Italian.srt"
}
}

5.2.24 - GET /services/media/createuploadlink/multiple?streams=1

Vastaa yksilöllisellä avaimella ja URL-osoitteella, jota käytetään videon lataamiseen palvelimeen.

Parametrit:

Esimerkkivastaus:
[
{
"url": "https://staging-chatter.s3.us-west-1.amazonaws.com/053b3e76-2759-48b9-8575-ea221e2949a9?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEMD%2F%2F%2F%2F%2F%22F%2F%2FARAAGgw2MzE5OTkzNDU1OTMiDIqw%2FI%2BuxmJSfzc7zCrXAw1usQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220118T165122Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=518399&X-Amz-Credential=ASIAZGJQYWO4QSXU3VAE%2F20220118%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Signature=1ee3b0fe2d3ce4997c3fbc522b46417fff562ba8f25be507baad2847f897a681",
"key": "053b3e76-2759-48b9-8575-ea221e2949a9"
}
]

5.2.25 - POST /services/media/upload/video/multiple

Tuo monivirtavideot käyttäjän oletuskokoelmaan.

Parametrit:

Esimerkkipyyntö:

{
"login_id": "john_doe",
"title": "Multi Stream Ingestion",
"description": "",
"file_keys":[
"379e3235-0538-480d-8bf2-14f74b328",
"7b31d4b8-c8c2-468b-87e2-2f4505258f"
]
}

Esimerkkivastaus:

{
"success": true,
"message": "Uplaoded Successfully, video will be available soon!"
}

5.2.26 - POST /services/media/document_link/{video_id}/{media_file_id}

Liittää mediatiedoston videolähteeseen.

Parametrit:

Esimerkkivastaus:

{
"success": true
}

5.2.27 - DELETE /services/media/document_link/{video_id}/{media_file_id}

Poistaa mediatiedoston videolähteestä.

Parametrit:

Esimerkkivastaus:

{
"success": true
}

5.2.28 - POST /services/media/videos/{video_id}/indexes

Lisää kirjanmerkillä merkittyjä aikaleimoja videolähteeseen.

Parametrit:

Esimerkki-JSON-data:

{
"timestamp": "0:06:10",
"label": "Bookmark 1",
"bold": false,
"indent": 0
}

Esimerkkivastaus:

{
"success": true
}

5.2.29 - DELETE /services/media/videos/{video_id}/indexes/{index}

Poista kirjanmerkillä merkittyjä aikaleimoja videolähteestä.

Parametrit:

Esimerkkivastaus:

{
"success": true
}

5.2.30 - GET /services/media/folder/{folder_Id}

Hae tietoja Luminan kansioista.

Parametri:

Esimerkkivastaus:

{
"directLink": "https://api-testing.yuja.com/V/PlayList?node=9875788&a=599025644",
"embedCode": "<iframe width='100%' height='540' src=\"https://evergreen.yuja.com/V/PlayList?node=9875788&a=599025644&preload=false\" frameborder=\"0\" webkitallowfullscreen mozallowfullscreen allowfullscreen loading=\"lazy\"></iframe>"
"folderPID": 9875788,
"folderTitle": "mp3_test1",
"folderVideosCount": 0
}

5.2.31 - POST /services/media/videos/{video_id}/captions/{language}/text/{line}/{position}

Lisää tekstitystiedostoon raakarungon tekstin.

Parametri:

Esimerkkivastaus:

{
"success": true
}

5.2.32 - DELETE /services/media/videos/{video_id}/captions/{language}/text/{line}/{start}/{end}

Poistaa tekstiä tekstitystiedostosta.

Parametri:

Esimerkkivastaus:

{
"success": true
}

5.2.33 - POST /services/media/videos/{video_id}/captions/{language}

Lisää tekstitysrivin.

Parametri:

Esimerkki-JSON-data:

{
"start_time": "00:00:10",
"stop_time": "00:00:15",
"text": "text"
}

Esimerkkivastaus:

{
"success": true
}

5.2.34 - DELETE /services/media/videos/{video_id}/captions/{language}/{line}

Poistaa tekstitysrivin.

Parametri:

Esimerkkivastaus:

{
"success": true
}

5.2.35 - POST /services/media/videos/{video_id}/captions/{language}/generatetranscript

Luo transkription videon tekstityksen avulla.

Parametri:

Esimerkkivastaus:

{
"success": true
}

5.2.36 - POST /services/media/publishToInstitutionChannel/video

Julkaise video EnterpriseTubeen tai CampusTubeen.

Esimerkki-URL: https://api-testing.yuja.com/services/media/publishToInstitutionChannel/video

Parametrit:
Tähän kutsuun ei tarvita parametreja.

Esimerkki-JSON-data:

Tämä päätepiste odottaa JSON-dataa tässä muodossa runkoparametrissa:

{
"login_id":"aswin_syras",
"folder_id":"9913954",
"videonode_id":"9964550"
}

Esimerkkivastaus:

Published video: success.

5.2.37 - POST /services/media/unpublishMedia

Poista video julkaisusta EnterpriseTubesta tai CampusTubesta.

Esimerkki-URL: https://api-testing.yuja.com/services/media/unpublishMedia

Parametrit:
Tähän kutsuun ei tarvita parametreja.

Esimerkki-JSON-data:

Tämä päätepiste odottaa JSON-dataa tässä muodossa runkoparametrissa:

{
"login_id":"michael_lee",
"videonode_id":"9964550"
}

Esimerkkivastaus:

Unpublished video: success.

5.2.38 - GET /services/media/allFolders/ETubeAndILib?{pageNumber}&{pageSize}

Noutaa kansiot EnterpriseTubesta ja CampusTubesta.

Esimerkki-URL: https://api-testing.yuja.com/services/media/allFolders/ETubeAndILib?pageNumber=4&pageSize=20

Parametrit:

Esimerkkivastaus:

[{"folderPID":5,"folderTitle":"Library","directLink":"https://staging-demo.yuja.com/V/PlayList?node\u003d5\u0026a\u003d1376969883","embedCode":"\u003ciframe width\u003d\u0027100%\u0027 height\u003d\u0027540\u0027 src\u003d\"https://staging-demo.yuja.com/V/PlayList?node\u003d5\u0026a\u003d1376969883\u0026preload\u003dfalse\" frameborder\u003d\"0\" webkitallowfullscreen mozallowfullscreen allowfullscreen loading\u003d\"lazy\"\u003e\u003c/iframe\u003e","folderVideosCount":7},{"folderPID":6,"folderTitle":"Featured Videos","directLink":"https://staging-demo.yuja.com/V/PlayList?node\u003d6\u0026a\u003d347409592","embedCode":"\u003ciframe width\u003d\u0027100%\u0027 height\u003d\u0027540\u0027 src\u003d\"https://staging-demo.yuja.com/V/PlayList?node\u003d6\u0026a\u003d347409592\u0026preload\u003dfalse\" frameborder\u003d\"0\" webkitallowfullscreen mozallowfullscreen allowfullscreen loading\u003d\"lazy\"\u003e\u003c/iframe\u003e","folderVideosCount":8},{"folderPID":9700540,"folderTitle":"Sauga","directLink":"https://staging-demo.yuja.com/V/PlayList?node\u003d9700540\u0026a\u003d1359623583","embedCode":"\u003ciframe width\u003d\u0027100%\u0027 height\u003d\u0027540\u0027 src\u003d\"https://staging-demo.yuja.com/V/PlayList?node\u003d9700540\u0026a\u003d1359623583\u0026preload\u003dfalse\" frameborder\u003d\"0\" webkitallowfullscreen mozallowfullscreen allowfullscreen loading\u003d\"lazy\"\u003e\u003c/iframe\u003e","folderVideosCount":4},{"folderPID":9700561,"folderTitle":"North York Campus"
}]

5.2.39 - GET /services/media/retrievefolderassets/{folderID}

Noutaa kaikki kansion sisällä olevat aineistot.

Esimerkki-URL: https://api-testing.yuja.com/services/media/retrievefolderassets/9995943

Parametri:

Esimerkkivastaus:

[{"Node_id":9995953,"Asset_type":"Video File","title":"chemistry","video_id":304743},{"Node_id":9995957,"Asset_type":"Video File","title":"intro to anthropology","video_id":299276},{"Asset_type":"Folder","folder_id":9995958,"title":"Algebra I"},{"Node_id":9995995,"Asset_type":"Video File","title":"Why we sleep","video_id":304762},{"Node_id":9995998,"Asset_type":"Video File","title":"Public speaking","video_id":304763},{"Node_id":9996001,"Asset_type":"Video File","title":"biological anthropology":304765}]

5.2.40 - POST /services/media/RSS

Hae kansion tiedot, joihin kuuluvat kansiossa olevat videot ja pääsy videolinkkeihin.

Esimerkki-URL: https://api-testing.yuja.com/services/media/RSS

Parametrit:
Tähän kutsuun ei tarvita parametreja.

Esimerkki-JSON-data:

Tämä päätepiste odottaa JSON-dataa tässä muodossa runkoparametrissa:

{
"folderID":"9913952",
"directStreamEnabled" : "true" OR "false"
}

Esimerkkivastaus:

https://api-testing.yuja.com/P/RSSFeeds/2/992532

5.2.41 - GET /services/media/video/{video_id}

Hae videon tiedot sen video_id-tunnuksella tai muokatun ja korvatun videon tiedot syöttämällä sen alkuperäinen video_id.

Esimerkki-URL: https://api-testing.yuja.com/services/media/video/313415

Parametri:

Esimerkkivastaus:

{

"videoPID": 318918,

"videoTitle": "Environmental Science ",

"videoDesc": "",

"ownerName": "ryan",

"duration": "209.92",

"createdDate": "2023-07-06 13:59:49"

}

5.2.42 - POST /services/media/createFolderInEnterpriseTubeLibrary

Luo alikansion EnterpriseTube Library -kansion sisään.

Esimerkki-URL: https://api-testing.yuja.com/services/media/createFolderInEnterpriseTubeLibrary

Parametrit:

Parametreja ei vaadita.

Tämä päätepiste odottaa JSON-dataa tässä muodossa runkoparametrissa:

{

"loginId":"brianstev",

"title":"Campus Life",

"nodePID":"10177148"

}

Esimerkkivastaus:

Folder created successfully

5.2.43 - POST /services/media/createFolderInSharedFolder

Luo kansion tai alikansion SharedFolder/Internal Library -kansion sisään.

Esimerkki-URL: https://api-testing.yuja.com/services/media/createFolderInSharedFolder

Parametrit:

Parametreja ei vaadita.

Tämä päätepiste odottaa JSON-dataa tässä muodossa runkoparametrissa:

{

"loginId":"brianstev",

"title":"Intro to Anthropology",

"nodePID":"10172048"

}

Esimerkkivastaus:

Folder created successfully

5.2.44 - POST /services/media/captionFileUploadLink

Antaa URL-osoitteen, jonka avulla tekstitys- tai transkriptiotiedosto voidaan ladata palvelimeen. URL-osoitetta käyttävä API on kohdassa 5.2.45. Lisäksi annetaan avain, jota käytetään kohdassa 5.2.46 olevan API:n JSON-runkoparametrissa.

Esimerkki-URL: https://api-testing.yuja.com/services/media/captionFIleUploadLink

Parametrit:

Parametreja ei vaadita.

Tämä päätepiste odottaa JSON-dataa tässä muodossa runkoparametrissa tekstityksille:

{

"videoPID": "672982",

"extension": "srt/vtt",

"type": "caption",

"language": "language of the caption file"

}

Tämä päätepiste odottaa JSON-dataa tässä muodossa runkoparametrissa transkriptioille ja PDF-tiedostoille:

{

"videoPID": "491182",

"type": "txt/pdf"

}

Esimerkkivastaus:

{
"url":"https://staging-yuja-upload.s3.us-west-1.amazonaws.com/294229_english.srt?x-amz-storage-class=INTELLIGENT_TIERING&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEMn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLXdlc3QtMSJHMEUCIDC%2F3c5R9xvAdVWtVuM5A9DaBun3cSkPri4vSMOnqr2lAiEA1Yvp7joCt016nE9w3psZbLAbZVSOLcN2qva21CLPx4cquwUIkv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARAAGgw2MzE5OTkzNDU1OTMiDEzdcJiKNf1jrn7ZByqPBYZXTrOZWoeXWxDDoWQhb4vfn%2FltSvEB315uCYAptKXLiKcIZj88MZsgEUPf%2FYvC%2B1%2FcNkYfxCWWZLSVPtCtrfm%2FXc9w359kHBsBOAD02rj6Z%2BRXOMAZTqbQ%2F%2FnNWzZjCJobgUxjXlU6pwys39JhhGN7X05mt6HCpCXpIyYe0vj8T7vWuIs5T%2FZF0nT9mo9cMN6hkj2qyPHmt8syI8kMttvyyakJ1CxCMZQcc0qdPhzgmTp1n9sV6Y5oi1jyyHG57Ja%2BQ2%2BLXqggS2egxA0n6A9dI1IHs1ZFCiPvfIp0UYiDQRQgyV1B0wrRfovcR2NAGHg4c1RbP7bmeObzE%2F%2BVktIMpGXuQkQIvqLxy9VdThk7wACZ1zx3XC6Jr%2FMNrE95P252esq9GmMW7Xykg83jXg1cVSNGy36LSeST%2FeF4Ub65WI1UWn2wHdsdvcjJGmAWbLX8qZBuTLhWCQ3Rt1F%2Bc3gYIbh%2BcuvzBiSdjDpuKPAtERShHwhuvrbUY31EkDBMeqj2G3KkCKmZkDqXCNnY7jCVrnvPQobD5MMIEXGA%2BZM3QEakotwNOOWgXX8%2FlWgxTimtk%2B83pxp6m%2FxiivIDVeTkQ8mAP3i4QB0bUuNf076KErbT8khbVduIQMyz3VJ0YhnmGq3dwgDxTgu40UA%2FlcUd9y2oOqfBj5AezxU3cjNEPBYiid7jY7siZAHCwWUS5nbPxkj7ASeen5m2nEhyN8nzZ9M6n26ZOFMXaQTstAgWnhkU4iP1ayt%2FELZESXTllpin%2FjHvUjDca7cMm1fJjJr06eJTxpjsjI3d%2Fx8oHVlVpsJXhm7mkM6f4ddpyfSFFN3iSqfsqkWEa9t06HeLpeTcBPzTUIQUY%2F8NatWRMYwsKmzpwY6sQFrbZTQQ1QMerTBaivYS%2BQ0bH6osAbrbWGeQJ2C1VnKhU1GsHNUTdbuyANoLProgcri6yvz5ZFzwzNsNpjN%2FZngqn3OFJ1TyBpW9EO5pR1fx%2BtqBR8vqwHZnpTiisFAVdxU4Jfi1eVcvCkGza9otufU9mLG4E1Bw21kYTVKPXN7ENnH5NYEoGhqb6nxZlEEKXUhDvK8NQCUKDwKY7eHOV4o3DCV9x0yiZXfRE30LCGX0G0%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230828T181024Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=ASIAZGJQYWO4X4VIAIPW%2F20230828%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Signature=18393b17290ec181bfb6a8ab53b58998de77202c91e34ede49489ee7a96ddc45","key":"294229_english.srt"
}

5.2.45 - PUT <URL_Received_from_the_API_in_Section_5.2.44>

Lähettää tekstitystiedoston palvelimelle, jonka jälkeen se voidaan lisätä videoon kohdan 5.2.46 API:lla.

Esimerkki-URL: https://staging-yuja-upload.s3.us-west-1.amazonaws.com/294229_english.srt?x-amz-storage-class=INTELLIGENT_TIERING&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEMn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLXdlc3QtMSJHMEUCIDC%2F3c5R9xvAdVWtVuM5A9DaBun3cSkPri4vSMOnqr2lAiEA1Yvp7joCt016nE9w3psZbLAbZVSOLcN2qva21CLPx4cquwUIkv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARAAGgw2MzE5OTkzNDU1OTMiDEzdcJiKNf1jrn7ZByqPBYZXTrOZWoeXWxDDoWQhb4vfn%2FltSvEB315uCYAptKXLiKcIZj88MZsgEUPf%2FYvC%2B1%2FcNkYfxCWWZLSVPtCtrfm%2FXc9w359kHBsBOAD02rj6Z%2BRXOMAZTqbQ%2F%2FnNWzZjCJobgUxjXlU6pwys39JhhGN7X05mt6HCpCXpIyYe0vj8T7vWuIs5T%2FZF0nT9mo9cMN6hkj2qyPHmt8syI8kMttvyyakJ1CxCMZQcc0qdPhzgmTp1n9sV6Y5oi1jyyHG57Ja%2BQ2%2BLXqggS2egxA0n6A9dI1IHs1ZFCiPvfIp0UYiDQRQgyV1B0wrRfovcR2NAGHg4c1RbP7bmeObzE%2F%2BVktIMpGXuQkQIvqLxy9VdThk7wACZ1zx3XC6Jr%2FMNrE95P252esq9GmMW7Xykg83jXg1cVSNGy36LSeST%2FeF4Ub65WI1UWn2wHdsdvcjJGmAWbLX8qZBuTLhWCQ3Rt1F%2Bc3gYIbh%2BcuvzBiSdjDpuKPAtERShHwhuvrbUY31EkDBMeqj2G3KkCKmZkDqXCNnY7jCVrnvPQobD5MMIEXGA%2BZM3QakotwNOOWgXX8%2FlWgxTimtk%2B83pxp6m%2FxiivIDVeTkQ8mAP3i4QB0bUuNf076KErbT8khbVduIQMyz3VJ0YhnmGq3dwgDxTgu40UA%2FlcUd9y2oOqfBj5AezTxU3cjNEPBYiid7jY7siZAHCwWUS5nbPxkj7ASeen5m2nEhyN8nzZ9M6n26ZOFMXaQTstAgWnhkU4iP1ayt%2FELZESXTllpin%2FjHvUjDca7cMm1fJjJr06eJTxpjsjI3d%2Fx8oHVlVpsJXhm7mkM6f4ddpyfSFFN3iSqfsqkWEa9t06HeLpeTcBPzTUIQUY%2F8NatWRMYwsKmzpwY6sQFrbZTQQ1QMerTBaivYS%2BQ0bH6osAbrbWGeQJ2C1VnKhU1GsHNUTdbuyANoLProgcri6yvz5ZFzwzNsNpjN%2FZngqn3OFJ1TyBpW9EO5pR1fx%2BtqBR8vqwHZnpTiisFAVdxU4Jfi1eVcvCkGza9otufU9mLG4E1Bw21kYTVKPXN7ENnH5NYEoGhqb6nxZlEEKXUhDvK8NQCUKDwKY7eHOV4o3DCV9x0yiZXfRE30LCGX0G0%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230828T181024Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=ASIAZGJQYWO4X4VIAIPW%2F20230828%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Signature=18393b17290ec181bfb6a8ab53b58998de77202c91e34ede49489ee7a96ddc45

Parametrit:

Parametreja ei tarvita.

Tämä päätepiste odottaa binääridataa, joka välitetään lähettämällä tekstitys- tai transkriptiotiedostosi palvelimeen.

Esimerkkivastaus:

200 OK

5.2.46 - POST /services/media/captionFileToVideo

Lähetä tekstitys- tai transkriptiotiedosto valittuun videoon.

Esimerkki-URL: https://api-testing.yuja.com/services/media/captionFileToVideo

Parametrit:

Parametreja ei tarvita.

Tämä päätepiste odottaa JSON-dataa tässä muodossa body-parametrissa tekstityksiä varten:

{

"login_id": "749371",

"videoPID": "74492",

"file_key": "294229_english.srt",

"type": "caption"

}

Esimerkkivastaus:

File uploaded successfully

Tämä päätepiste odottaa JSON-dataa tässä muodossa body-parametrissa transkriptioita varten:

{

"videoPID": "74492",

"type": "txt/pdf"

}

Esimerkkivastaus:

File uploaded successfully

5.2.47 - GET /services/metadata/oai-pmh?verb=GetRecord&identifier={videoPID}&metadataPrefix=<lom_ims or oai_dc>

Palauttaa Luminassa käyttäjän lisäämät metatiedot. Huomautus: API löytää vain sellaisen median, jonka haku API:lla on sallittu. Jos haluat ottaa median haun API:lla käyttöön, katso oppaamme Median haettavuuden salliminen API:lla.

Esimerkki-URL: https://api-testing.yuja.com/services/metadata/oai-pmh?verb=GetRecord&identifier=4827

Parametri:

Esimerkkivastaus:

<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">
<responseDate>2024-03-04T19:13:26Z</responseDate>
<request identifier="323797" metadataPrefix="oai_dc" verb="GetRecord">https://evergreen.yuja.com/services/</request>
<GetRecord>
<record>
<header>
<identifier>321797</identifier>
<datestamp>2023-08-31T20:13:04Z</datestamp>
<setSpec/>
</header>
<metadata>
<oai_dc:dc xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd">
<dc:description/>
<dc:publisher>Joran Manson</dc:publisher>
<dc:date>08/31/2023</dc:date>
<dc:type/>
<dc:format/>
<dc:identifier>323797</dc:identifier>
<dc:source>https://evergreen.yuja.com/V/Video?v=321797&amp;a=109689478</dc:source>
<dc:language>en</dc:language>
<dc:relation/>
<dc:coverage/>
<dc:rights/>
<dc:list>chunky</dc:list>
<dc:date2/>
<With_Space/>
<thh_new_space/>
<dc:contributor>Jordan Manson</dc:contributor>
<search/>
</oai_dc:dc>
</metadata>
</record>
</GetRecord>
</OAI-PMH>

5.2.48 - GET /services/metadata/oai-pmh?verb=ListRecords&metadataPrefix=<lom_ims or oai_dc>

Palauttaa kaikki metatietoja sisältävät tiedostot, joiden Median tiedoissa on valittuna vaihtoehto ”Salli tämän median haku API:lla”. Halutessa voidaan käyttää myös päivämääräväliä. Huomautus: Vain 100 ensimmäistä tiedostoa palautetaan. Seuraavat 100 tiedostoa saadaan ajamalla API uudelleen vastauksessa annetulla jatkotunnisteella.

Esimerkki-URL: https://api-testing.yuja.com/services/metadata/oai-pmh?verb=ListRecords

Esimerkki-URL päivämääräväliä käytettäessä: https://api-testing.yuja.com/services/metadata/oai-pmh?verb=ListRecords&from=2023-01-01&until=2024-03-01

Esimerkki-URL jatkotunnisteen kanssa: https://api-testing.yuja.com/services/metadata/oai-pmh?&verb=ListRecords&resumptionToken=eyJhbGciOiJub25lIn0.eyJsaW1pdCI6MTAwLCJtZXRob2RQcmVmaXgiOiIiLCJ0aW1lc3RhbXAiOjE3MDk1NzIyNzQTB9.

Parametrit:

Tähän kutsuun ei tarvita parametreja.

Esimerkkivastaus:

<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">
<responseDate>2024-03-04T19:11:47Z</responseDate>
<request metadataPrefix="oai_dc" verb="ListRecords">https://staging-demo.yuja.com/services/</request>
<ListRecords>
<record>
<header>
<identifier>271109</identifier>
<datestamp>2022-08-30T21:34:23Z</datestamp>
<setSpec/>
</header>
<metadata>
<oai_dc:dc xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd">
<dc:description>1255</dc:description>
<dc:publisher>Martin Lauro</dc:publisher>
<dc:date>08/30/2022</dc:date>
<dc:type/>
<dc:format/>
<dc:identifier>271109</dc:identifier>
<dc:source>https://evergreen.yuja.com/V/Video?v=271129&amp;a=167512691</dc:source>
<dc:language>en</dc:language>
<dc:relation/>
<dc:coverage/>
<dc:rights/>
<dc:list>chunky</dc:list>
<dc:date2/>
<With_Space/>
<thh_new_space/>
<dc:contributor>saleena mgeorge</dc:contributor>
<search/>
</oai_dc:dc>
</metadata>
</record>
<resumptionToken>eyJhbGciOiJub25lIn0.eyJsaW1pdCI6MTAwLCJtZXRob2RQcmVmaXgiOiIiLCJ0aW1lc3RhbXAiOjE3MDk1Nzk1MDg1NDh9.</resumptionToken>
</ListRecords>
</OAI-PMH>

5.2.49 - GET /services/metadata/oai-pmh?verb=ListIdentifiers

Palauttaa kaikki tiedostot, joilla on Video- tai Media-PID ja jotka eivät sisällä metatietoja, halutessa rajattuna päivämäärävälillä. Vain 100 ensimmäistä tiedostoa palautetaan. Seuraavat 100 tiedostoa saadaan ajamalla API uudelleen vastauksessa annetulla jatkotunnisteella. Huomautus: API löytää vain sellaisen median, jonka haku API:lla on sallittu. Jos haluat ottaa median haun API:lla käyttöön, katso oppaamme Median haettavuuden salliminen API:lla.

Esimerkki-URL: https://api-testing.yuja.com/services/metadata/oai-pmh?verb=ListIdentifiers

Esimerkki-URL päivämääräväliä käytettäessä: https://api-testing.yuja.com/services/metadata/oai-pmh?verb=ListIdentifiers&from=2023-01-01&until=2024-03-01

Esimerkki-URL jatkotunnisteen kanssa: https://api-testing.yuja.com/services/metadata/oai-pmh?&verb=ListIdentifiers&resumptionToken=eyJhbGciOiJub25lIn0.eyJsaW1pdCI6MTAwLCJtZXRob2RQcmVmaXgiOiIiLCJ0aW1lc3RhbXAiOjE3MDk1NzIyNzQTB9. (Huomautus: Päivämääräväliä ei voi käyttää jatkotunnisteen kanssa.)

Parametrit:

Tähän kutsuun ei tarvita parametreja.

Esimerkkivastaus:

<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">
<responseDate>2024-03-04T19:09:44Z</responseDate>
<request metadataPrefix="oai_dc" verb="ListIdentifiers">https://staging-demo.yuja.com/services/</request>
<ListIdentifier>
<header>
<identifier>271109</identifier>
<datestamp>2022-08-30T21:34:23Z</datestamp>
<setSpec/>
</header>
<header>
<identifier>27652</identifier>
<datestamp>2021-11-17T20:25:07Z</datestamp>
<setSpec/>
</header>
<resumptionToken>eyJhbGciOiJub25lIn0.eyJsaW1pdCI6MTAwLCJtZXRob2RQcmVmaXgiOiIiLCJ0aW1lc3RhbXAiOjE3MDk1NzkzODQ0OD.</resumptionToken>
</ListIdentifier>
</OAI-PMH>

5.2.50 - GET /services/metadata/oai-pmh?verb=Identify

Palauttaa tämän API:n tiedot, kuten tietovaraston nimen, yhteyssähköpostiosoitteen ja muut olennaiset tiedot.

Esimerkki-URL: https://api-testing.yuja.com/services/metadata/oai-pmh?verb=Identify

Parametrit:

Tähän kutsuun ei tarvita parametreja.

Esimerkkivastaus:

<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">
<responseDate>2024-03-04T19:08:45Z</responseDate>
<request verb="Identify">https://evergreen.yuja.com/services/</request>
<Identify>
<repositoryName>YuJa Enterprise Video Platform</repositoryName>
<baseURL>https://evergreen.yuja.com/services/</baseURL>
<protocolVersion>1.0</protocolVersion>
<adminEmail>support@yuja.com</adminEmail>
<earliestDatestamp>2024-03-04T00:00:00Z</earliestDatestamp>
<deletedRecord>persistent</deletedRecord>
<granularity>YYYY-MM-DDThh:mm:ssZ</granularity>
</Identify>
</OAI-PMH>

5.2.51 - GET /services/metadata/oai-pmh?verb=ListMetadataFormats

Palauttaa dokumentaation Dublin Core -toteutuksesta, jota käytetään metatietojen muotoiluun API:illa 5.2.47–5.2.49.

Esimerkki-URL: https://api-hudson.yuja.com/services/metadata/oai-pmh?verb=Identify

Parametrit:

Tähän kutsuun ei tarvita parametreja.

Esimerkkivastaus:

<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">
<responseDate>2024-03-04T19:07:39Z</responseDate>
<request verb="ListMetadataFormats">https://staging-demo.yuja.com/services/</request>
<ListMetadataFormats>
<metadataFormat>
<metadataPrefix>oai_dc</metadataPrefix>
<schema>https://www.dublincore.org/specifications/dublin-core/dces/1999-07-02/</schema>
<metadataNamespace>https://schema.org/</metadataNamespace>
</metadataFormat>
</ListMetadataFormats>
</OAI-PMH>

5.2.52 GET /services/media/video/{video_id}/captions

Lataa videon tekstitystiedoston.

Esimerkki-URL: https://api-hudson.yuja.com/services/media/video/146852/captions

Parametrit:

Tähän kutsuun ei tarvita parametreja.

Esimerkkivastaus:

"English": "https://api-hudson.s3.us-west-1.amazonaws.com/489890_English.srt?X-Amz-Security-Token=IBnJb3JpZ2lun1VjEPL%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLXdlc3QtMSJIMELMQDYm3K1ksoNy4opXIjBMBJrp6Qjr7NCPDj1T3EJWQGNKwIhAItNIZWxg%2BNCQifjW8xCI6dfGJMg5edLLpYHQk4kD%2BAhKrIFCBsQABoMNjMxOTk5MzQ1NTkzIgxBv0Yv4gDr0snlDh4qjwVLraCQo4TcpTfL%2FzVXWXhnoBvuA1DElXi4qZb70lo3KLlc47z9V4XHOcGLDA5sx9yNU0LdR%2Fq8s%2FKxpZfvKs2iIy1lmU9ufOCAJlay%2BssJN4E3O%2BsFpHb6NCMsQc%2BVrG%2FHAWDCTi%2F1SAbTTTkFSvz8QCG3KN7zY8EoHpbp1pVM0Fs%2F7yHZD0yCoJHR18%2FC6QImVHQKx1dCXBEumc1gQiymsbFRFch5swNyCuV%2FqPYPWrheCo3G%2FwXttkHNvtyMWX0zW9TUsyweiTiINg9TYQ3En2VvPW0AUz8ldg0aAXOH%2F58MIceDL1d0ReXe2BIbROJEpTUFdbH7cM5wyX0CmPoV%2BOf6V9yA3cIbIyZIc4xeFLvnPuGV0l4RVm396F529F%2FesjjVhbO5Kes2Vmb8QN1onNQdJiaDGlw184U3qIOqjhi9dXxnrEFusKAd9%2FpHNllz00t2%2Be8SAIijOQmEjkAUo6vO0saKMwHuzkHAC8dXOePfYga8sYf5mOOrjsliPgi6dGG72GfpucUNd9ODVDFIVqjA3e8GtSTXoBeqd1JWY55k52ZO5twTS6U82BzPetD2b0njoUJMn3GKfJJj34S02DLobmYqebBmiNkqRxH9HJPDxGdAvdphNKJkQND1VUO%2FE1OokGx0Fj7mvC0MIiq8iHqeXBkgp4XsXlFjjaCRslT7TaIdlKf8widO6T%2Bv1V4xOa1IiXclmHBRgP%2F9OA2n0YA%2F43cleZrvz2uuGYY3EjWeVLW7Qhd76HBokkorzCog4cCedfwIs3tBfw%2FXH1qmwVDYD9ghWp8UuY9S3InvGjfrA2aaXB3Esl%2FCzeXAzZNL3JTFp9wMVzuxCDdBLjJganPVJuRJMgJUgVIPkqG2MOS8hMQGOrABVQkKcbeYPVWbp95PHprNovna8E8lGpstUxpIHX%2Bg%2FsCrz7%2FkwQ3r5chw%2BAPp4Gl2RieJowaHE%2B7Vm1OcD1FGTv2wm%2B3kZwMZc13SW30n7CD3%2BZSgM2B4GPe5hww6b1VbfSs2KZ38cZ1wqY3DHAxz1%2FrrPoFG1Ax%2FtXuXAlvm8NufrKj0dhPwhcBOJcOt6n20wq1wqw5evOjyovU96%2Brayzn4gsK2hbj9aRj1IhIJfLU%3D&X-Amz-Algorithm=AWS4-HNAC-SHA256&X-Amz-Date=20250723T183412Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86549&X-Amz-Credential=ASICAYJQYWO474CQZN7R%2F20250713%2Fus-west-1%2Cs3%2Faws4_request&X-Amz-Signature=55763a2548L17dc16063e3fa74813da2881464689a45acf98f22d850"

5.2.53 - POST /services/media/importLink

Tuo video toiselta alustalta YuJa Luminan mediakirjastoon latauslinkin avulla.

Esimerkki-URL: https://staging-demo.yuja.com/services/media/importLink

Parametrit:

Tämä päätepiste odottaa JSON-dataa tässä muodossa body-parametrissa:

{
"login_id":"12",
"title":"Lecture 1",
"description":"Recording of Lecture 1",
"DownloadURL":"https:\/\/cdnapisec.kaltura.com\/p\/1038472\/sp\/103847200\/playManifest\/entryId\/1_2iep6n7p\/format\/download\/protocol\/https\/flavorParamIds\/0",
"autoEAD":true
}

Esimerkkivastaus:

{
"title": "Lecture 1",
"id": 1234567,
"videoDirectLink": "https://staging-demo.yuja.com/V/Video?v=1234567&a=987654321"
}

6 - Analytiikka-API:n yleiskatsaus

Mediat​ kattavat kaikki oppilaitoksen aineistot. Tähän kuuluvat äänitiedostot, videotiedostot ja muut asiakirjat.

6.1 - Analytiikkaobjektimalli

6.2 - Pääasialliset päätepisteet

6.2.1 - GET /analytics/report/bandwidth/{group_id}

Palauttaa tiedoston, joka sisältää ryhmän kaistanleveyden käyttötiedot.

Esimerkki-URL: https://api-testing.yuja.com/services/analytics/report/bandwidth/1365

Parametrit:

6.2.2 - GET /analytics/report/storage/{group_id}

Palauttaa tiedoston, joka sisältää ryhmän tallennustilan käyttötiedot.

Esimerkki-URL: https://api-testing.yuja.com/services/analytics/report/storage/1365

Parametrit:

6.2.3 - GET /analytics/report/videoview/{group_id}

Palauttaa tiedoston, joka sisältää ryhmän videonkatselutiedot.

Esimerkki-URL: https://api-testing.yuja.com/services/analytics/report/videoview/1365

Parametrit:

6.2.4 - GET /analytics/report/visitors

Palauttaa tiedoston, joka sisältää oppilaitoksen kävijätiedot.

Esimerkki-URL: https://api-testing.yuja.com/services/analytics/report/visitors

Parametrit:

Tähän kutsuun ei tarvita parametreja.

7 - Auditointilokin API:n yleiskatsaus

AuditLog edustaa kaikkia lokeja, jotka ovat saatavilla päivämäärävälin ja tyypin perusteella.

7.1 - Auditointilokin objektimalli

7.2 - Pääasialliset päätepisteet

7.2.1 - GET /auditLog/entries

Palauttaa JSON-luettelon objekteista, joista kukin on lokimerkintä.

Esimerkki-URL: https://staging-demo.yuja.com/services/auditLog/entries?startTime=01/12/2024&endTime=02/01/2025&eventType=New Log In

Parametrit

Esimerkkivastaus:
[
{
"creationTimestamp": "2021-05-20 16:48:48",
"eventName": "Change Owner",
"details": "John changed owner of media object titled mpg_test1 from user JohnInstructor to user David"
},
{ "creationTimestamp": "2021-05-18 16:11:31",
"eventName":"Change Owner",
"details": "Nick changed owner of media object titled My Event on Thursday, March 30, 2017 from user Ronald to user Terry"
}
]