Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Atualização dos dados de um canal preexistente

Para o uso desse endpoint é necessário que suas credenciais de acesso tenham permissão para o uso do OAuth 2.0 para autorização.

POST https://eduplay.rnp.br/services/userchannel/update/{identifierOrigin}

Path Parameters

Name
Type
Description

identifierOrigin*

String

identificador único do canal no sistema de origem

Query Parameters

Name
Type
Description

removeThumb

Boolean

definir se a miniatura existente deve ser removida, no caso de não ser enviado outro arquivo de miniatura. Se o parâmetro for definido como false e não for enviado o arquivo de miniatura, o anterior (caso exista) será mantido.

removeCover

Boolean

definir se a imagem de capa existente deve ser removida, no caso de não ser enviado outro arquivo de imagem. Se o parâmetro for definido como false e não for enviado o arquivo de imagem, o anterior (caso exista) será mantido.

Request Body

Name
Type
Description

userChannel*

userChannel

parâmetro do tipo multipart com as informações do canal a ser salvo, conforme formato do tipo userChannelMetadata, definido na descrição dos serviços em api-docs.

thumbnail

binary

parâmetro do tipo multipart: arquivo com a miniatura do canal (screenshot).

coverimage

binary

parâmetro do tipo multipart: arquivo com a imagem de capa do canal (screenshot). 

{
    // Response
}

Considerações sobre os metadados para o novo canal:

  • As informações obrigatórias são: name e visibility.

  • É possível enviar a opção removeAllMemberspara definir que todos os membros atuais do canal (caso existam) devem ser removidos.

  • É possível definir as seguintes opções de visibilidade:

    • PUBLIC - acesso público tanto pelo eduplay como por embed

    • PRIVATE - acesso apenas a usuários autenticados no eduplay.

  • É possível definir uma lista de membros aos quais o canal deve ser associado, por meio do elemento members. As informações de email e type são obrigatórias. O e-mail do membro enviado deve pertence a um usuário com conta ativa no eduplay. Os tipos de membros podem ser:

    • VIEWER - acesso aos conteúdos restritos ao canal;

    • PUBLISHER - além de acessar os conteúdos restritos, pode cadastrar novos conteúdos e gerenciar os conteúdos existentes no canal;

    • ADMIN - além de ter as mesmas funcionalidades do PUBLISHER, pode gerenciar os demais membros do canal.

  • No caso da edição, na lista de membros pode ser definido se um membro atual deve ser removido com o atributo removeMember ou se o tipo do membro atual deve ser alterado com o atributo changeType. Se nenhum dos dois parâmetros for enviado é considerado que trata-se da adição de um novo membro.

  • Exemplo de definição do elemento members em formato XML:

    <members>
	<member>
		<type>ADMIN</type>
		<email>user1@email.com</email>
		<changeType>true</changeType>
	</member>
	<member>
		<type>VIEWER</type>
		<email>user2@email.com</email>
		<removeMember>true</removeMember>
	</member>	
</members>
PreviousPublicação de novo canalNextEnvio de estatísticas a partir de player externo

Last updated

Was this helpful?