YuJa API

Autenticação

Toda chamada de API exige um token de autenticação como cabeçalho. Esses tokens são gerados por gerentes de TI/administradores e podem ser revogados. Os tokens de autenticação permitem o acesso à API de uma instituição específica. O token tem 32 caracteres e pode ser obtido em Painel de administração -> API.

Lembre-se de também salvar o token da API depois de gerá-lo.

Uso do token: o token deve ser enviado como cabeçalho, com a chave “authToken” e o valor igual ao token, em cada chamada de API

URL base da API

A URL base da YuJa API atual é {organization_subdomain}.yuja.com/services/. O Organization_subdomain é atribuído quando a conta da organização é provisionada na YuJa. Por motivos de segurança, apenas o acesso por https é permitido. Por exemplo, se o domínio atribuído à organização for tested, a página inicial será api-testing.yuja.com e o endpoint da API será api-testing.yuja.com/services.

Parâmetros da requisição

Há várias maneiras de passar parâmetros de requisição para chamadas de API.

• Como componente do caminho da URL. Isso é chamado de parâmetro de caminho.
• Como parte da query string. Isso é chamado de parâmetro de query string.
• No corpo da requisição, para requisições que não sejam GET. Isso é chamado de parâmetro de corpo. O conteúdo deve ser codificado em JSON.
• No cabeçalho personalizado HTTP. Isso é chamado de parâmetro de cabeçalho.

Operações CRUD

As APIs seguem a convenção REST para realizar as funcionalidades CREATE, READ, UPDATE e DELETE. A tabela a seguir descreve a convenção comum utilizada.

Códigos de resposta da API REST

1 - Visão geral da API de usuários

Os usuários representam todos os usuários registrados na instituição. Isso inclui instrutores, estudantes e gerentes de TI. Os usuários podem ser matriculados em cursos, criar capturas e solicitar reuniões, convidar para elas ou ser convidados. Os usuários também podem ter uma coleção de vídeos.

1.1 - Modelo de objeto de usuário

Para obter o user_id dos usuários, primeiro faça a chamada de API GET /users (Seção 1.2.1). Na resposta, é possível coletar o user_id de todos os usuários, que poderá ser usado depois em outras chamadas de API.

1.2 - Principais endpoints

1.2.1 - GET /services/users

Retorna uma lista JSON de objetos, em que cada objeto é um usuário. Nenhum parâmetro é necessário para esta chamada.

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

Exemplo de resposta:

[

{

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

Retorna um objeto JSON com as informações do estudante.

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

Parâmetros:

Exemplo de resposta:

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

Cria um novo usuário na instituição. Os dados JSON podem ser compostos sem os parâmetros opcionais. Consulte a Seção 1.1 para ver os detalhes dos parâmetros.

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

Parâmetros:

Este endpoint espera dados JSON neste formato no parâmetro de corpo:

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

Dados JSON de exemplo:

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

Atualiza um único usuário com base em {user_id}. Consulte a Seção 1.1 para ver os detalhes dos parâmetros.

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

Parâmetros:

Este endpoint espera dados JSON neste formato no parâmetro de corpo:

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

Todos os campos são opcionais. Somente os campos informados são atualizados.

1.2.5 - DELETE /services/users/{user_id}

Remove da instituição o usuário com o ID {user_id}.

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

Parâmetros:

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

Recupera todos os grupos nos quais um usuário está matriculado.

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

Parâmetros:

Exemplo de resposta:

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

Recupera todos os grupos dos quais um usuário é proprietário de conteúdo. O user_id necessário pode ser obtido com a chamada de API GET /users.

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

Parâmetros:

Nenhum parâmetro é necessário.

Exemplo de resposta:

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

Cria novos usuários com base nos mesmos parâmetros dos endpoints post de services e users (consulte a Seção 1.2.3), com dois parâmetros adicionais: primary_identifier e secondary_identifier. Isso vinculará o usuário a usuários existentes ou futuros criados por meio da integração com LMS ou SSO. Embora primary_identifier e secondary_identifier sejam opcionais, um dos dois parâmetros deve estar presente. Entre em contato com o suporte da YuJa se precisar de mais assistência.

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

Parâmetros:

1.2.9 - POST /services/media/permission

Adicione ou modifique permissões de pastas no CampusTube ou no EnterpriseTube.

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

Parâmetros:
Nenhum parâmetro é necessário para esta chamada.

Dados JSON de exemplo:

Este endpoint espera dados JSON neste formato no parâmetro de corpo:

Use a entrada JSON abaixo ao atribuir com base na função:
{
"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"
}

Use a entrada JSON abaixo ao atribuir com base no usuário:
{
"folderID": "9931153",
"type": "User",
"updateDescendants": "true" OR "false",
"userName": "username",
"access": "Full Access" OR "Edit Access" OR "Edit Caption Access" OR "Read Access"
}

Use a entrada JSON abaixo ao atribuir com base no grupo:
{
"folderID": "9931153",
"type": "Group",
"updateDescendants": "true" OR "false",
"groupName": "group name",
"access": "Full Access" OR "Edit Access" OR "Edit Caption Access" OR "Read Access"
}

Exemplo de resposta:

Successfuly Modified permission

1.2.10 - DELETE /services/media/permission

Exclui as permissões de uma pasta.

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

Parâmetros:
Nenhum parâmetro é necessário para esta chamada.

Dados JSON de exemplo:

Este endpoint espera dados JSON neste formato no parâmetro de corpo:

Use a entrada JSON abaixo ao atribuir com base em uma função:
{
"folderID":"9931153",
"type": "Role",
"name": "Student" OR "Instructor"
}

Use a entrada JSON abaixo ao atribuir com base no usuário:
{
"folderID": "9931153",
"type": "User",
"userName": "username"
}

Use a entrada JSON abaixo ao atribuir com base no grupo:
{
"folderID": "9931153",
"type": "Group",
"groupName": "group name"
}

Exemplo de resposta:

Success

1.2.11 - POST /services/media/mediaByLinkageValue

Obtenha informações sobre os vídeos contidos na conta do usuário usando um valor de “linkage”. Ele pode ser obtido em Painel de administração > Lista de usuários do Lumina, visualizando a coluna Linkage de um usuário. Selecione o tipo de linkage dele na coluna e copie o valor de LTI Linkage, LTI3 Linkage ou SAML Linkage fornecido.

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

Parâmetros:
Nenhum parâmetro é necessário para esta chamada.

Dados JSON de exemplo:

Este endpoint espera dados JSON neste formato no parâmetro de corpo:

{
"linkage": "stu.bct"
}

Exemplo de resposta:

[

{

"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

Adicione um usuário a uma pasta compartilhada com as permissões especificadas.

URL de exemplo: https://hudson.yuja.com/services/media/modifySharePermissions

Parâmetros:

Dados JSON de exemplo:

Este endpoint espera dados JSON neste formato no parâmetro de corpo:

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

Exemplo de resposta:

Share list successfully updated.

1.2.13 - DELETE /services/media/modifySharePermissions

Remova um usuário de uma pasta compartilhada.

URL de exemplo: https://hudson.yuja.com/services/media/modifySharePermissions

Parâmetros:

Dados JSON de exemplo:

Este endpoint espera dados JSON neste formato no parâmetro de corpo:

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

Exemplo de resposta:

Share list successfully updated.

1.2.14 - PUT /services/users/updateStatus

Altere o status da conta de um usuário usando o ID de usuário, o ID de login ou o e-mail dele. Para atualizar vários usuários de uma vez, use uma lista de IDs de usuário, IDs de login ou e-mails. No total, é preciso informar dois parâmetros: email OU login_id OU user_id, e status.

URL de exemplo: https://hudsonlake.yuja.com/services/users/updateStatus

Parâmetros:

Alteração do status da conta usando user_id

Dados JSON de exemplo:

Este endpoint espera dados JSON neste formato no parâmetro de corpo:

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

Exemplo de resposta:

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

Alteração do status da conta usando o e-mail

Dados JSON de exemplo:

Este endpoint espera dados JSON neste formato no parâmetro de corpo:

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

Exemplo de resposta:

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

2 - Visão geral da API de grupos

Os grupos representam todos os cursos disponíveis na organização. Cada curso tem uma segurança de curso específica, que filtra o acesso dos usuários a ele. O curso também pode publicar políticas que permitem que apenas certos tipos de usuários publiquem nesses grupos.

Observação: À medida que avançamos na distinção entre cursos e grupos, as APIs existentes das seções 2.2.1 a 2.2.13 continuarão funcionando normalmente por enquanto. Para migrar para as APIs mais atuais para cursos, recomendamos usar as APIs das seções 2.2.14 a 2.2.23. Para APIs específicas de grupos, consulte a seção abaixo, intitulada 3 - Visão geral da API UserGroups.

2.1 - Modelo de objeto de grupo

Para obter o group_id dos grupos, primeiro faça a chamada de API GET /groups (Seção 2.2.1). Na resposta, é possível coletar o group_id de todos os grupos, que poderá ser usado depois em outras chamadas de API.

2.2 - Principais endpoints

2.2.1 - GET /services/groups

Retorna uma lista JSON de todos os grupos, organizada em páginas de 1000 grupos. Se quiser retornar todos os grupos em uma única página, entre em contato com o seu gerente de contas para alterar a funcionalidade desta API para a sua instituição. Observação: Você não poderá retornar todos os grupos em uma única página após 31 de dezembro de 2023.

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

Parâmetros:

Exemplo de resposta:

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

Retorna um objeto JSON com as informações do grupo.

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

Parâmetros:

Exemplo de resposta:

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

Edita as informações de um grupo com id {group_id}. Consulte a seção 2.1 para ver os detalhes dos parâmetros.

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

Parâmetros:

Este endpoint espera dados JSON neste formato no parâmetro de corpo:

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

Todos os campos são opcionais. Somente os campos informados são atualizados.

2.2.4 - POST /services/groups

Cria um novo grupo. Consulte a seção 2.1 para ver os detalhes dos parâmetros.

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

Este endpoint espera dados JSON neste formato no parâmetro de corpo:

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

Remove da instituição um grupo/turma com id {group_id}.

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

Parâmetros:

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

Adiciona um usuário a um grupo como membro.

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

Parâmetros:

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

Adiciona um usuário a um grupo como proprietário de conteúdo.

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

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

Retorna uma lista JSON de objetos, em que cada objeto é um usuário que é proprietário de conteúdo do grupo com id {group_id}.

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

Exemplo de resposta:

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

Retorna uma lista JSON de objetos, em que cada objeto é um usuário que é membro do grupo com id {group_id}.

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

Parâmetros:

Exemplo de resposta:

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

Remove o membro com id {user_id} de um grupo com id {group_id}.

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

Parâmetros:

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

Remove o proprietário de conteúdo com id {user_id} de um grupo com id {group_id}.

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

Parâmetros:

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

Retorna os detalhes do grupo para o código de grupo informado (código do curso).

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

Parâmetros:

Exemplo de resposta:

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

Cria grupos e/ou adiciona membros a grupos.

URL de exemplo: https://evergreen.yuja.com/services/users/createGroup

Parâmetros:

Nenhum parâmetro é necessário para esta chamada.

Exemplo de dados JSON:

Este endpoint espera dados JSON neste formato no parâmetro de corpo:

{

"groupName": "ChemistryGroup",

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

}

Exemplo de resposta:

Group created successfully

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

Retorna os detalhes do curso para o código de curso informado.

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

Parâmetros:

Exemplo de resposta:

{

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

Exclui o proprietário de um curso.

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

Parâmetros:

Exemplo de resposta:

Successfully deleted user from group/class

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

Exclui um membro pertencente a um curso.

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

Parâmetros:

Exemplo de resposta:

Successfully deleted user from group/class

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

Recupera os proprietários do curso.

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

Parâmetros:

Exemplo de resposta:

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

Exclui o curso.

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

Parâmetros:

Exemplo de resposta:

Successfully deleted course/class

2.2.19 - PUT /services/courses/{course_id}

Edita um curso existente.

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

Parâmetros:

Este endpoint espera dados JSON neste formato no parâmetro de corpo:

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

Exemplo de resposta:

Successfully updated course of id: 2463

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

Adiciona um proprietário a um curso existente.

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

Parâmetros:

Exemplo de resposta:

Successfully made user a content owner to this course/class

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

Adiciona um membro a um curso existente.

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

Parâmetros:

Exemplo de resposta:

Successfully made user a member to this course/class

2.2.22 - POST /services/courses

Cria um novo curso.

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

Este endpoint espera dados JSON neste formato no parâmetro de corpo:

{

"owner_id": 374971,

"course_name": "newcourse1",

"course_code": "999000",

"course_term": "Summer",

"publish_type": "ADMIN"

}

Exemplo de resposta:

Successfully created a new course

2.2.23 - GET /services/courses

Recupera os detalhes dos cursos em lotes de 200.

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

Exemplo de resposta:

{"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 - Visão geral da API UserGroups

Os UserGroups representam todos os grupos disponíveis na organização. Cada grupo tem um ID exclusivo e membros que podem ser adicionados ou removidos.

3.1 - Modelo de objeto de dispositivo

3.2 - Principais endpoints

3.2.1 - GET /services/usergroups/all

Recupera todos os grupos.

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

Exemplo de resposta:

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

Recupera todos os grupos aos quais um usuário pertence.

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

Parâmetros:

Exemplo de resposta:

[
Anthropology, Microbiology, AdminGroup
]

3.2.3 - GET /services/usergroups/name/members

Recupera todos os membros de um grupo pelo nome do grupo.

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

Este endpoint espera dados JSON neste formato no parâmetro de corpo:

{
"groupName":"anthropology"
}

Exemplo de resposta:

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

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

Recupera todos os membros de um grupo pelo ID do grupo.

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

Parâmetros:

Exemplo de resposta:

[
472862, 840173, 294591
]

3.2.5 - GET /services/usergroups/{group_id}

Recupera as informações de um grupo pelo ID do grupo.

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

Parâmetros:

Exemplo de resposta:

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

3.2.6 - POST /services/usergroups/create

Cria um grupo e adiciona membros. Se o grupo já existir, os membros serão adicionados a ele. Para criar um grupo sem membros, insira "groupMembers":"" nos dados JSON.

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

Este endpoint espera dados JSON neste formato no parâmetro de corpo:

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

Exemplo de resposta:

Group created and Members added successfully

3.2.7 - PUT /services/usergroups/{group_id}

Edita o nome de um grupo.

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

Parâmetros:

Este endpoint espera dados JSON neste formato no parâmetro de corpo:

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

Exemplo de resposta:

Successfully changed the group name

3.2.8 - DELETE /services/usergroups/{group_id}

Exclui o nome de um grupo.

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

Parâmetros:

Exemplo de resposta:

Successfully deleted the group

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

Remove todos os membros de um grupo.

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

Parâmetros:

Exemplo de resposta:

Successfully cleared group members

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

Exclui um membro específico do grupo pelo ID dele.

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

Parâmetros:

Exemplo de resposta:

Successfully deleted group member

3.2.11 - POST /services/usergroups/foldersByGroupPID

Recupera uma lista das pastas às quais o grupo especificado tem acesso.

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

Parâmetros:

Exemplo de solicitação:

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

Exemplo de resposta:

[
{
"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 - Visão geral da API Device

Os dispositivos representam todos os dispositivos de captura registrados na organização. Opcionalmente, cada dispositivo pode receber um IP na interface de gerenciamento. Este ID será recuperado junto com os demais IDs de dispositivo.

4.1 - Modelo de objeto de dispositivo

4.2 - Principais endpoints

4.2.1 - GET /services/devices

Retorna uma lista JSON de objetos, em que cada objeto é um dispositivo.

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

Parâmetros:

Nenhum parâmetro é necessário para esta chamada.

Exemplo de resposta:

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

Retorna um objeto JSON, em que o objeto é um dispositivo.

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

Parâmetros:

Exemplo de resposta:

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

4.2.3 - PUT /services/devices/{device_id}

Atualiza o dispositivo.

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

Parâmetros:

4.2.4 - POST /services/devices/register

Registra um dispositivo. Você pode usar o endpoint existente PUT /devices/{device_id} para editar o dispositivo após o registro.

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

Parâmetros:

Exemplo de solicitação:

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

Exemplo de resposta:

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

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

Uma forma alternativa de usar GET para obter informações do dispositivo, usando access_id em vez do device_id interno do Lumina. Disponível apenas para tipos de dispositivo que usam um access_id.

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

Parâmetros:

Exemplo de resposta:

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

Retorna os detalhes das sessões do dispositivo em um período.

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

Parâmetros:

Exemplo de resposta:

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

Cria um perfil de captura para um dispositivo.

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

Parâmetros: O corpo conterá um array JSON em que cada objeto JSON terá os campos a seguir.

Exemplo de requisição:

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

Exemplo de resposta:

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

Cria uma sessão.

URL de exemplo: https://api-testing.yuja.com/services/devices/session

Parâmetros:

Exemplo de requisição:

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

Exemplo de resposta:

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

Inicia uma sessão imediatamente.

URL de exemplo: https://api-testing.yuja.com/services/devices/startsession

Parâmetros:

Exemplo de requisição:

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

Um endpoint que responde com URLs de transmissão ao vivo e URLs de reprodução para um determinado sessionId. Observação: antes de usar a API, o YuJa Software Capture deve estar registrado na sua zona.

Parâmetros da requisição:

JSONArray (array dos seguintes objetos JSON) (máximo de 3 transmissões permitidas por sessão)

Exemplo de corpo da requisição:

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

Exemplo de resposta:

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

Interrompe uma sessão imediatamente.

URL de exemplo: https://api-testing.yuja.com/services/devices/stopstation

Parâmetros:

Exemplo de requisição:

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

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

Um endpoint para enviar periodicamente informações de status e de registro à Lumina. Isso inclui nossos registros de auditoria, registros de erros e alertas, como os de microfone com volume baixo (áudio de entrada).

URL de exemplo: https://api-testing.yuja.com/services/devices/12345/status

Parâmetros:

Exemplo de requisição:

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

Exemplo de resposta:

{
“success”: true
}

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

A estação consultará a Lumina periodicamente para obter os comandos de pausa ou parada, que serão usados para o controle, durante a sessão, de uma sessão ativa. O intervalo de consulta no meio de uma sessão de gravação terá frequência maior do que quando a estação está em espera. A frequência máxima de consulta não deve exceder uma vez a cada 10 segundos.

URL de exemplo: https://api-testing.yuja.com/services/devices/session/614/commands

Parâmetros:

Resposta:

4.2.14 - DELETE /services/devices/{session_id}

Exclui uma sessão agendada.

URL de exemplo: https://api-testing.yuja.com/services/devices/679

Parâmetros:

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

Obtém os perfis de um usuário específico com um dispositivo específico.

URL de exemplo: https://api-testing.yuja.com/services/devices/profiles/12345/loginID123

Parâmetros:

Exemplo de resposta:

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

Obtém os perfis de um usuário específico com um dispositivo específico.

URL de exemplo: https://api-testing.yuja.com/services/devices/profiles/12345

Parâmetros:

Exemplo de resposta:

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

Recupera o userID correspondente.

URL de exemplo: https://api-testing.yuja.com/services/devices/userid/testuser

Parâmetros:

Exemplo de resposta:

testuser

4.2.18 - POST /services/devices/editsession

Atualiza uma sessão com os parâmetros fornecidos.

URL de exemplo: https://api-testing.yuja.com/services/devices/editsession

Parâmetros:

Exemplo de requisição:

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

Exclui todas as sessões agendadas associadas ao dispositivo.

URL de exemplo: https://api-testing.yuja.com/services/devices/12345/schedules

Parâmetros:

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

Retorna os detalhes do usuário em um período.

URL de exemplo: https://api-testing.yuja.com/services/devices/marythompson

Parâmetros:

Exemplo de resposta:

[

{

"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

Um endpoint para enviar periodicamente informações de status e de registro ao YuJa EVP.

Parâmetros:

URL de exemplo: https://api-testing.yuja.com/services/devices/1480/status

Exemplo de corpo da requisição:

{
"statusType": "DEVICE_STATUS",
"deviceStatus": {
"recording": false,
"uploading": true,
"streaming": false,
"ready": true,
“extra_info”: objeto JSON contendo quaisquer outras informações úteis que ainda serão definidas.
}
}

Exemplo de resposta:

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

Observação: command e command_data são marcadores de posição para funcionalidades futuras de controle dos dispositivos, como a possibilidade de instruir os dispositivos a pausar/encerrar a sessão pelo nosso portal.

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

Um endpoint para criar perfis de hub.

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

Parâmetros:

Exemplo de corpo da requisição:

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

Exemplo de resposta:

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

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

Um endpoint para atualizar um perfil de hub.

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

Parâmetros:

Exemplo de corpo da requisição:
{
"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
}
Exemplo de resposta:
{
"errorMessage": "",
"success": true
}

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

Um endpoint para excluir um perfil de hub.

URL de exemplo:

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

Parâmetros:

Exemplo de resposta:

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

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

Retorna o ID de perfil da YuJa correspondente ao ID de perfil externo informado.

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

Parâmetros:

Exemplo de resposta:

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

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

Exclui qualquer dispositivo registrado.

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

Parâmetros:

Exemplo de resposta:

{
"success": true
}

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

Estende o tempo de sessão de dispositivos de terceiros (por padrão, em 30 minutos).

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

Parâmetros:

Exemplo de resposta:

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

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

Retorna as URLs S3 pré-assinadas que podem ser usadas para atualizar as prévias de áudio/imagem.

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

Parâmetros:

Exemplo de resposta:

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

Interrompe imediatamente a sessão de dispositivos de terceiros

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

Parâmetros:

Exemplo de resposta:

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

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

Pausa a reprodução da transmissão ao vivo de uma sessão específica.

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

Parâmetros:

Exemplo de resposta:

{
"success": true
}

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

Retoma a reprodução da transmissão ao vivo de uma sessão específica.

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

Parâmetros:

Exemplo de resposta:

{
"success": true
}

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

Exclui perfis de terceiros.

Parâmetros:

Exemplo de resposta:

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

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

Atualiza os detalhes de perfis de terceiros.

Parâmetros:

Exemplo de corpo da requisição:

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

Exemplo de resposta:

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

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

Retorna as URLs de prévia de vídeo e áudio para o dispositivo informado e o perfil correspondente.

Parâmetros:

Exemplo de resposta:

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

Responde com os status de dispositivo das estações YSC registradas.

Parâmetros:

Exemplo de resposta:

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

5 - Visão geral da API de mídia

A mídia​ representa todos os ativos da instituição. Isso inclui arquivos de áudio, arquivos de vídeo e outros documentos.

5.1 - Modelo de objeto de mídia

5.2 - Principais endpoints

5.2.1 - GET /services/createuploadlink

Retorna um objeto JSON que contém o link de upload e o file_key. Para fazer upload do vídeo no S3, faça uma solicitação HTTP PUT usando o link de upload retornado como destino e anexe o arquivo de vídeo.

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

Parâmetros:

Nenhum parâmetro é necessário para esta chamada.

Exemplo de resposta:

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

5.2.2 - POST /services/upload/video/

Faz upload de um vídeo na biblioteca de mídia de um usuário com o login_id correspondente do parâmetro de corpo.

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

Parâmetros:

5.2.3 - POST /services/publish/video/

Publica um vídeo pertencente ao usuário com login_id em um grupo com o group_id correspondente do parâmetro de corpo.

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

Parâmetros:

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

Retorna um objeto JSON com os detalhes dos vídeos da turma.

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

Parâmetros:

Exemplo de resposta:

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

Retorna um objeto JSON com o link direto e o código de incorporação de um vídeo.

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

Parâmetros:

Exemplo de resposta:

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

5.2.6 - POST /services/replace/video/

Substitui um vídeo pertencente ao usuário com login_id por outro vídeo.

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

Parâmetros:

5.2.7 - GET /services/retrievebranding

Retorna um objeto JSON com os detalhes de personalização de marca do player de mídia da organização.

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

Parâmetros:

Nenhum parâmetro é necessário para esta chamada.

Exemplo de resposta:

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

5.2.8 - PUT /services/updatebranding/

Atualiza os detalhes de personalização de marca do player de mídia da organização.

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

Parâmetros:

5.2.9 - GET /services/retrieveuserassets/{login_id}

Retorna um objeto JSON com os detalhes dos vídeos da turma.

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

Parâmetros:

Exemplo de resposta:

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

Gera links de upload para enviar as gravações da sessão.

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

Parâmetros:

Campos de video_sources:

Campos de pause_timestamps:

Exemplo de solicitação:

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

Exemplo de resposta:

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

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

Sinaliza que o upload da gravação para os URLs do S3 foi concluído e que o processamento do vídeo deve começar.

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

Parâmetros:

Exemplo de resposta:

{
“success”: true
}

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

Recupera todas as entradas de metadados referentes ao video_id informado.

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

Parâmetros:

Exemplo de resposta:

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

Insere todas as entradas de metadados referentes ao video_id informado.

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

Parâmetros:

Campos de newMetadata:

Exemplo de parâmetros de corpo:
{
newMetadata: [
{
"Name": "PhyExam",
"Type": "String",
"Value": "Easy"
},
{
"Name": "ChemExam",
"Type": "Date",
"Value": "05/05/2021"
}
]
}

Exemplo de resposta:

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

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

Exclui todas as entradas de metadados referentes ao video_id informado e à lista informada de nomes de metadados.

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

Parâmetros:

Exemplo de parâmetros de corpo:

[
"PhyExam",
"ChemExam"
]

Exemplo de resposta:

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

5.2.15 - GET /services/media/searchVideo

Recupera todos os vídeos de acordo com os critérios de pesquisa informados no parâmetro de corpo.

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

Parâmetros:

Exemplo de parâmetros de corpo:
{
"searchString": "Polish",
"searchAs": "John_ITManager",
"searchInMediaContent": "false",
"ownerId": "",
"createdBefore": "",
"createdAfter": "",
"tag":"",
"metadata": ""
}

Exemplo de resposta:

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

Recupera todos os vídeos de acordo com os critérios de pesquisa informados nos parâmetros de consulta.

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

Parâmetros:

Exemplo de resposta:

[
{
"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 - Handlers expostos

Vamos escutar o evento postMessage, que transmitirá um parâmetro JSON.

Parâmetros do evento:

Exemplo de parâmetro JSON:

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

Recupera todas as pastas às quais um usuário tem acesso no YuJa, de acordo com o user_id informado.

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

Parâmetros:

Exemplo de resposta:

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

Recupera todos os vídeos aos quais um usuário tem acesso no YuJa, de acordo com o user_id informado.

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

Parâmetros:

Exemplo de resposta:

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

Recupera os vídeos de uma pasta específica à qual um usuário tem acesso no YuJa.

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

Parâmetros:

Exemplo de resposta:

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

Recupera todos os vídeos de acordo com os critérios de pesquisa informados nos parâmetros de consulta.

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

Parâmetros:

Exemplo de resposta:

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

Retorna os fluxos HLS junto com outras informações importantes sobre o vídeo.

Parâmetros:

Exemplo de resposta:
{
"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

Retorna as URLs das miniaturas, junto com outras informações importantes sobre o vídeo.

Parâmetros:

Exemplo de resposta:

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

Responde com uma chave exclusiva e uma URL que será usada para enviar o vídeo.

Parâmetros:

Exemplo de resposta:
[
{
"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

Ingere vídeos com vários streams na coleção padrão do usuário.

Parâmetros:

Exemplo de requisição:

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

Exemplo de resposta:

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

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

Anexa um arquivo de mídia a uma fonte de vídeo.

Parâmetros:

Exemplo de resposta:

{
"success": true
}

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

Remove um arquivo de mídia de uma fonte de vídeo.

Parâmetros:

Exemplo de resposta:

{
"success": true
}

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

Insere carimbos de tempo com marcadores em uma fonte de vídeo.

Parâmetros:

Exemplo de dados JSON:

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

Exemplo de resposta:

{
"success": true
}

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

Exclui carimbos de tempo com marcadores de uma fonte de vídeo.

Parâmetros:

Exemplo de resposta:

{
"success": true
}

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

Obtém informações sobre pastas dentro da plataforma de vídeo Lumina.

Parâmetro:

Exemplo de resposta:

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

Insere um corpo bruto de texto no arquivo de legendas.

Parâmetro:

Exemplo de resposta:

{
"success": true
}

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

Remove texto de um arquivo de legendas.

Parâmetro:

Exemplo de resposta:

{
"success": true
}

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

Insere uma linha de legenda.

Parâmetro:

Exemplo de dados JSON:

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

Exemplo de resposta:

{
"success": true
}

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

Remove uma linha de legenda.

Parâmetro:

Exemplo de resposta:

{
"success": true
}

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

Gera uma transcrição usando as legendas do vídeo.

Parâmetro:

Exemplo de resposta:

{
"success": true
}

5.2.36 - POST /services/media/publishToInstitutionChannel/video

Publica um vídeo no EnterpriseTube ou no CampusTube.

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

Parâmetros:
Nenhum parâmetro é necessário para esta chamada.

Exemplo de dados JSON:

Este endpoint espera dados JSON neste formato no parâmetro de corpo:

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

Exemplo de resposta:

Published video: success.

5.2.37 - POST /services/media/unpublishMedia

Cancela a publicação de um vídeo no EnterpriseTube ou no CampusTube.

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

Parâmetros:
Nenhum parâmetro é necessário para esta chamada.

Exemplo de dados JSON:

Este endpoint espera dados JSON neste formato no parâmetro de corpo:

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

Exemplo de resposta:

Unpublished video: success.

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

Recupera pastas do EnterpriseTube e do CampusTube.

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

Parâmetros:

Exemplo de resposta:

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

Recupera todos os ativos dentro de uma pasta.

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

Parâmetro:

Exemplo de resposta:

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

Obtém informações da pasta, incluindo quais vídeos estão dentro dela e o acesso aos links dos vídeos.

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

Parâmetros:
Nenhum parâmetro é necessário para esta chamada.

Exemplo de dados JSON:

Este endpoint espera dados JSON neste formato no parâmetro de corpo:

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

Exemplo de resposta:

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

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

Recupera os detalhes de um vídeo usando seu video_id, ou de um vídeo que foi editado e substituído, informando seu video_id original.

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

Parâmetro:

Exemplo de resposta:

{

"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

Cria uma subpasta dentro da pasta Library do EnterpriseTube.

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

Parâmetros:

Nenhum parâmetro é obrigatório.

Este endpoint espera dados JSON neste formato no parâmetro de corpo:

{

"loginId":"brianstev",

"title":"Campus Life",

"nodePID":"10177148"

}

Exemplo de resposta:

Folder created successfully

5.2.43 - POST /services/media/createFolderInSharedFolder

Cria uma pasta ou subpasta dentro de SharedFolder/Internal Library.

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

Parâmetros:

Nenhum parâmetro é obrigatório.

Este endpoint espera dados JSON neste formato no parâmetro de corpo:

{

"loginId":"brianstev",

"title":"Intro to Anthropology",

"nodePID":"10172048"

}

Exemplo de resposta:

Folder created successfully

5.2.44 - POST /services/media/captionFileUploadLink

Fornece uma URL que pode ser usada para enviar um arquivo de legendas ou de transcrição ao servidor. A API que usará a URL está na seção 5.2.45. Também será fornecida uma chave, usada no parâmetro de corpo JSON da API que está na seção 5.2.46.

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

Parâmetros:

Nenhum parâmetro é obrigatório.

Este endpoint espera dados JSON neste formato no parâmetro de corpo para legendas:

{

"videoPID": "672982",

"extension": "srt/vtt",

"type": "caption",

"language": "language of the caption file"

}

Este endpoint espera dados JSON neste formato no parâmetro de corpo para transcrições e PDF:

{

"videoPID": "491182",

"type": "txt/pdf"

}

Exemplo de resposta:

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

Envia um arquivo de legendas ao servidor, que pode então ser adicionado a um vídeo usando a API da seção 5.2.46

URL de exemplo: 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

Parâmetros:

Nenhum parâmetro é obrigatório.

Este endpoint espera dados binários, enviados por meio do upload do seu arquivo de legendas ou de transcrição.

Exemplo de resposta:

200 OK

5.2.46 - POST /services/media/captionFileToVideo

Envie um arquivo de legendas ou de transcrição para um vídeo selecionado.

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

Parâmetros:

Nenhum parâmetro é obrigatório.

Este endpoint espera dados JSON neste formato no parâmetro body para legendas:

{

"login_id": "749371",

"videoPID": "74492",

"file_key": "294229_english.srt",

"type": "caption"

}

Exemplo de resposta:

File uploaded successfully

Este endpoint espera dados JSON neste formato no parâmetro body para transcrições:

{

"videoPID": "74492",

"type": "txt/pdf"

}

Exemplo de resposta:

File uploaded successfully

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

Retorna os metadados adicionados pelo usuário no Lumina. Observação: A API localizará apenas mídias que podem ser pesquisadas por APIs. Para saber como habilitar sua mídia para a pesquisa por API, siga nosso guia Como permitir que a mídia seja pesquisável por APIs.

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

Parâmetro:

Exemplo de resposta:

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

Retorna todos os arquivos com metadados que tenham a opção “Permitir que esta mídia seja pesquisável por API” selecionada nos Detalhes da mídia. Se desejar, também é possível aplicar um intervalo de datas. Observação: Somente os primeiros 100 arquivos serão retornados. Para acessar mais 100 arquivos, a API precisará ser executada novamente com o token de retomada fornecido na resposta.

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

URL de exemplo com intervalo de datas: https://api-testing.yuja.com/services/metadata/oai-pmh?verb=ListRecords&from=2023-01-01&until=2024-03-01

URL de exemplo com token de retomada: https://api-testing.yuja.com/services/metadata/oai-pmh?&verb=ListRecords&resumptionToken=eyJhbGciOiJub25lIn0.eyJsaW1pdCI6MTAwLCJtZXRob2RQcmVmaXgiOiIiLCJ0aW1lc3RhbXAiOjE3MDk1NzIyNzQTB9.

Parâmetros:

Nenhum parâmetro é necessário para esta chamada.

Exemplo de resposta:

<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

Retorna todos os arquivos com PIDs de vídeo ou de mídia que não contêm nenhum metadado, dentro de um intervalo de datas opcional que pode ser incluído. Somente os primeiros 100 arquivos serão retornados. Para acessar mais 100 arquivos, a API precisará ser executada novamente com o token de retomada fornecido na resposta. Observação: A API localizará apenas mídias que podem ser pesquisadas por APIs. Para saber como habilitar sua mídia para a pesquisa por API, siga nosso guia Como permitir que a mídia seja pesquisável por APIs.

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

URL de exemplo com intervalo de datas: https://api-testing.yuja.com/services/metadata/oai-pmh?verb=ListIdentifiers&from=2023-01-01&until=2024-03-01

URL de exemplo com token de retomada: https://api-testing.yuja.com/services/metadata/oai-pmh?&verb=ListIdentifiers&resumptionToken=eyJhbGciOiJub25lIn0.eyJsaW1pdCI6MTAwLCJtZXRob2RQcmVmaXgiOiIiLCJ0aW1lc3RhbXAiOjE3MDk1NzIyNzQTB9. (Observação: Não é possível aplicar um intervalo de datas ao usar o token de retomada.)

Parâmetros:

Nenhum parâmetro é necessário para esta chamada.

Exemplo de resposta:

<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

Retorna detalhes desta API específica, como o nome do repositório, o e-mail de contato e outras informações relevantes.

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

Parâmetros:

Nenhum parâmetro é necessário para esta chamada.

Exemplo de resposta:

<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

Retorna a documentação sobre a implementação do Dublin Core usada na formatação de metadados das APIs 5.2.47 a 5.2.49.

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

Parâmetros:

Nenhum parâmetro é necessário para esta chamada.

Exemplo de resposta:

<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

Baixa o arquivo de legendas do vídeo.

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

Parâmetros:

Nenhum parâmetro é necessário para esta chamada.

Exemplo de resposta:

"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

Importe um vídeo de outra plataforma para a sua biblioteca de mídia do YuJa Lumina a partir de um link de download.

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

Parâmetros:

Este endpoint espera dados JSON neste formato no parâmetro body:

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

Exemplo de resposta:

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

6 - Visão geral da API de análises

A mídia​ representa todos os ativos da instituição. Isso inclui arquivos de áudio, arquivos de vídeo e outros documentos.

6.1 - Modelo de objeto de análises

6.2 - Principais endpoints

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

Retorna um arquivo com os detalhes de uso de largura de banda de um grupo.

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

Parâmetros:

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

Retorna um arquivo com os detalhes de uso de armazenamento de um grupo.

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

Parâmetros:

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

Retorna um arquivo com os detalhes de visualização de vídeo de um grupo.

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

Parâmetros:

6.2.4 - GET /analytics/report/visitors

Retorna um arquivo com os detalhes dos visitantes da instituição.

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

Parâmetros:

Nenhum parâmetro é obrigatório para esta chamada.

7 - Visão geral da API de log de auditoria

AuditLog representa todos os logs disponíveis com base no intervalo de datas e no tipo.

7.1 - Modelo de objeto do log de auditoria

7.2 - Principais endpoints

7.2.1 - GET /auditLog/entries

Retorna uma lista JSON de objetos, em que cada objeto é um log.

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

Parâmetros

Exemplo de resposta:
[
{
"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"
}
]