Publicação de novo canal

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/publish/{identifierOrigin}

Path Parameters

Name
Type
Description

identifierOrigin*

String

identificador único do canal no sistema de origem

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

<returnMessage>
	<operationCode>CODIGO_DA_OPERACAO_DE_SUCESSO_OU_ERRO</operationCode>
	<message>MENSAGEM_EXPLICATIVA</message>
	<result>ID_DO_CANAL_CRIADO</result> <!-- em caso de sucesso -->
</returnMessage>

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

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

  • É 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.

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

    <members>
	<member>
		<type>PUBLISHER</type>
		<email>user1@email.com</email>
	</member>
	<member>
		<type>VIEWER</type>
		<email>user2@email.com</email>
	</member>
</members>
PreviousCanais - Pontos de integraçãoNextAtualização dos dados de um canal preexistente

Last updated