Videos

Videos

SAPO Vídeos é um serviço gratuito on-line no qual os utilizadores podem fazer upload, compartilhar e assistir vídeos.

Subscrição gratuita

Descrição Técnica

Serviço Videos

Permite a pesquisa de vídeos usando as tags e categorias do serviço SAPO Videos.

Manual de Referência da API

Serviço Operação Descrição
Videos AddVideo Adicionar um novo vídeo na plataforma a partir de um ficheiro que se encontra no servidor de FTP, carregado anteriormente (para obter uma conta no servidor de FTP deve-se contactar a equipa técnica do Vídeos)
AddVideoPost Adicionar um novo vídeo na plataforma e fazer o upload deste por POST posteriormente. De modo a fazer o POST do ficheiro é necessário obter um token ao BUS com o randname do vídeo como parâmetro ExtraInfo. Este post deverá conter os seguintes campos: - token: token obtido a partir do BUS; - content_file: ficheiro a carregar; - redir: redireccionamento para o qual a janela de formulário deve ir após o POST (opcional, no caso de não ser passado este parâmetro é devolvido o resultado em XML; caso contrario é passado o resultado no parâmetro error do redireccionamento).
AddVideoToPlaylist Adicionar video à playlist
CheckPlaylist Devolve a informação de uma determinada playlist
CheckVideo Devolve a informação de um determinado vídeo
CreatePlaylist Create Playlist on user account
CreateUser Cria um novo utilizador
DeletePlaylist Remover um playlist
DeleteVideo Remover um vídeo
EditPlaylist Alterar os dados de determinada Playlist
EditVideo Alterar os dados de determinado vídeo
GetEncodeParameters Devolve os parâmetros de codificação de um vídeo para determinado perfil de codificação
GetEncodeProfilesForUser Devolve um array de perfis de codificação, que podem ser carregados pelo utilizador que estiver autenticado no serviço web.
GetUserInfo Devolve informação sobre um utilizador
GetUserInfoForDashboard GetUserInfoForDashboard
ListCategories Lista de categorias de plataformas
ListUserPlaylists Retorna a lista de canais do utilizador.
ListUserTags ListUserTags
ListUserVideos ListUserVideos
ListVideosFromPlaylist Retorna os videos de um canal
NotifyComment Notificar a plataforma de vídeos para esta actualizar as suas contagens quando são adicionados, alterados ou apagados comentários directamente na plataforma do SimpleForum (só utilizadores com permissões de "super utilizador" podem invocar este método)
Query Devolve uma listagem de vídeos com a possibilidade de aplicação de filtros
RemoveVideoFromPlaylist Remove um video da playlist
RSS2 Devolve uma lista de videos para o utilizador "vitor", filtrada pela tag "piadas", ordenada pela pontuação atribuída aos videos

Serviço Videos

Operações

AddVideo

Adicionar um novo vídeo na plataforma a partir de um ficheiro que se encontra no servidor de FTP, carregado anteriormente (para obter uma conta no servidor de FTP deve-se contactar a equipa técnica do Vídeos)
Parâmetros do pedido
Video : VideoSubmition (mandatório)
Email : string (opcional)
Parâmetros de resposta
AddVideoResult : Video (opcional)
Voltar ao topo

AddVideoPost

Adicionar um novo vídeo na plataforma e fazer o upload deste por POST posteriormente. De modo a fazer o POST do ficheiro é necessário obter um token ao BUS com o randname do vídeo como parâmetro ExtraInfo. Este post deverá conter os seguintes campos: - token: token obtido a partir do BUS; - content_file: ficheiro a carregar; - redir: redireccionamento para o qual a janela de formulário deve ir após o POST (opcional, no caso de não ser passado este parâmetro é devolvido o resultado em XML; caso contrario é passado o resultado no parâmetro error do redireccionamento).
Parâmetros do pedido
Video : VideoSubmition (mandatório)
Email : string (opcional)
Parâmetros de resposta
AddVideoPostResult : Video (opcional)
Voltar ao topo

AddVideoToPlaylist

Adicionar video à playlist
Parâmetros do pedido
Randname : string (mandatório)
Playlist : string (mandatório)
Email : string (opcional)
Interface : string (opcional)
Voltar ao topo

CheckPlaylist

Devolve a informação de uma determinada playlist
Parâmetros do pedido
PlaylistId : int (mandatório)
Email : string (opcional)
Interface : string (opcional)
Parâmetros de resposta
CheckPlaylistResult : Playlist (opcional)
Voltar ao topo

CheckVideo

Devolve a informação de um determinado vídeo
Parâmetros do pedido
VideoId : string (opcional)
Email : string (opcional)
VideoRandname : string (opcional)
Interface : string (opcional)
ShowComments : int (opcional)
Parâmetros de resposta
CheckVideoResult : Video (opcional)
Voltar ao topo

CreatePlaylist

Create Playlist on user account
Parâmetros do pedido
Email : string (opcional)
Playlist : PlaylistSubmition (mandatório)
Parâmetros de resposta
CreatePlaylistResult : Playlist (opcional)
Voltar ao topo

CreateUser

Cria um novo utilizador
Parâmetros do pedido
Email : string (mandatório)
Username : string (mandatório)
NewsLetter : int (mandatório)
Interface : string (opcional)
Voltar ao topo

DeletePlaylist

Remover um playlist
Parâmetros do pedido
PlaylistId : int (mandatório)
Email : string (opcional)
Interface : string (opcional)
Voltar ao topo

DeleteVideo

Remover um vídeo
Parâmetros do pedido
Randname : string (mandatório)
Email : string (opcional)
Interface : string (opcional)
Voltar ao topo

EditPlaylist

Alterar os dados de determinada Playlist
Parâmetros do pedido
Playlist : PlaylistSubmition (mandatório)
Email : string (opcional)
Interface : string (opcional)
Voltar ao topo

EditVideo

Alterar os dados de determinado vídeo
Parâmetros do pedido
Video : VideoSubmition (mandatório)
Email : string (opcional)
Interface : string (opcional)
Voltar ao topo

GetEncodeParameters

Devolve os parâmetros de codificação de um vídeo para determinado perfil de codificação
Parâmetros do pedido
EncId : int (opcional)
IdVideoWidth : int (opcional)
IdVideoHeight : int (opcional)
IdAudioBitrate : int (opcional)
IdAudioNch : int (opcional)
IdVideoFps : float (opcional)
Parâmetros de resposta
GetEncodeParametersResult : Params (opcional)
Voltar ao topo

GetEncodeProfilesForUser

Devolve um array de perfis de codificação, que podem ser carregados pelo utilizador que estiver autenticado no serviço web.
Parâmetros de resposta
GetEncodeProfilesForUserResult : ArrayOfEncodeProfile (opcional)
Voltar ao topo

GetUserInfo

Devolve informação sobre um utilizador
Parâmetros do pedido
Email : string (opcional)
Username : string (opcional)
Parâmetros de resposta
GetUserInfoResult : User (opcional)
Voltar ao topo

GetUserInfoForDashboard

GetUserInfoForDashboard
Parâmetros do pedido
Email : string (opcional)
Username : string (opcional)
Interface : string (opcional)
Parâmetros de resposta
GetUserInfoForDashboardResult : UserForDashboad (opcional)
Voltar ao topo

ListCategories

Lista de categorias de plataformas
Parâmetros de resposta
ListCategoriesResult : ArrayOfCategory (mandatório)
Voltar ao topo

ListUserPlaylists

Retorna a lista de canais do utilizador.
Parâmetros do pedido
Email : string (opcional)
Interface : string (opcional)
Page : int (opcional)
Limit : int (opcional)
Order : string (opcional)
Parâmetros de resposta
ListUserPlaylistsResult : ArrayOfPlaylist (opcional)
Voltar ao topo

ListUserTags

ListUserTags
Parâmetros do pedido
Email : string (opcional)
Interface : string (opcional)
Limit : int (opcional)
Parâmetros de resposta
ListUserTagsResult : ArrayOfTag (opcional)
Voltar ao topo

ListUserVideos

ListUserVideos
Parâmetros do pedido
Email : string (opcional)
Interface : string (opcional)
Order : string (opcional)
Limit : int (opcional)
Page : int (opcional)
Parâmetros de resposta
ListUserVideosResult : ArrayOfVideo (opcional)
Voltar ao topo

ListVideosFromPlaylist

Retorna os videos de um canal
Parâmetros do pedido
Playlist : string (mandatório)
Email : string (opcional)
Interface : string (opcional)
Order : string (opcional)
Limit : int (opcional)
Page : int (opcional)
Parâmetros de resposta
ListVideosFromPlaylistResult : ArrayOfVideo (opcional)
Voltar ao topo

NotifyComment

Notificar a plataforma de vídeos para esta actualizar as suas contagens quando são adicionados, alterados ou apagados comentários directamente na plataforma do SimpleForum (só utilizadores com permissões de "super utilizador" podem invocar este método)
Parâmetros do pedido
Randname : string (mandatório)
Interface : string (opcional)
Voltar ao topo

Query

Devolve uma listagem de vídeos com a possibilidade de aplicação de filtros
Parâmetros do pedido
Emails : string (opcional)
Tags : string (opcional)
Cos : int (opcional)
Limit : int (opcional)
Order : string (opcional)
ViewAll : int (opcional)
Interface : string (opcional)
ShowTags : int (opcional)
Parâmetros de resposta
QueryResult : ArrayOfVideo (opcional)
Voltar ao topo

RemoveVideoFromPlaylist

Remove um video da playlist
Parâmetros do pedido
Randname : string (mandatório)
Playlist : string (mandatório)
Email : string (opcional)
Interface : string (opcional)
Voltar ao topo

RSS2

Devolve uma lista de videos para o utilizador "vitor", filtrada pela tag "piadas", ordenada pela pontuação atribuída aos videos
Exemplos

Devolve uma lista de videos para o utilizador "vitor", filtrada pela tag "piadas", ordenada pela pontuação atribuída aos videos

Devolve uma lista de videos para o utilizador "vitor", filtrada pela expressão "piadas", ordenada pelo número de visualizações, com um limite de 10 resultados

Retorna uma lista dos videos mais recentes para o utilizador "vitor"

Devolve uma lista de videos relacionados com o video identificado pelo randname especificado

Devolve uma lista de videos do canal "10" do utilizador "olimpiadas2008", página 1 limitada por 10 elementos

Devolve uma lista de videos para o utilizador "vitor", os 10 elementos da página 2

Return a list of channels filtered by the search term "humor", limited to 10 results

Return a list of last channels for the user "olimpiadas2008", page 2 limited by 10 results
Voltar ao topo

Videos Entidades

ArrayOfCategory

Nome do atributo Descrição
Lista de item : Category (opcional)
Voltar ao topo

ArrayOfComment

Nome do atributo Descrição
Lista de item : Comment (opcional)
Voltar ao topo

ArrayOfEncodeProfile

Nome do atributo Descrição
Lista de item : EncodeProfile (opcional)
Voltar ao topo

ArrayOfPlaylist

Nome do atributo Descrição
Lista de item : Playlist (opcional)
Voltar ao topo

ArrayOfTag

Nome do atributo Descrição
Lista de item : Tag (opcional)
Voltar ao topo

ArrayOfVideo

Nome do atributo Descrição
Lista de item : Video (opcional)
Voltar ao topo

Category

Nome do atributo Descrição
Id : int
Name : string
Voltar ao topo

Comment

Nome do atributo Descrição
Date : string
Nickname : string
Website : string
Body : string
Voltar ao topo

EncodeProfile

Nome do atributo Descrição
Id : int
Name : string
Extension : string
ToEncode : int
Voltar ao topo

Params

Nome do atributo Descrição
ExpWidth : int
ExpHeight : int
ScaleWidth : int
ScaleHeight : int
SoundRate : int
SoundMode : int
VideoFps : float
VideoExtension : string
VideoBitrate : int
Voltar ao topo

Playlist

Nome do atributo Descrição
Id : int
Active : int
CreationDate : string
Description : string
Title : string
Tags : string (opcional)
URL : string
Thumbnail : string
TotalVideos : int
ResultTotalPlaylists : int (opcional)
Voltar ao topo

PlaylistSubmition

Nome do atributo Descrição
Id : int (opcional)
Title : string
Active : int
Description : string
Tags : string
Voltar ao topo

Tag

Nome do atributo Descrição
Tag : string
Count : int (opcional)
Voltar ao topo

User

Nome do atributo Descrição
Id : int
Active : int
Banned : int
CommentCaptcha : int
CommentModerate : int
CommentNotify : int
CreationDate : string
Email : string
LastLogin : string
Partner : int
UploadMail : string
Username : string
ViewAll : int
Website : string
Voltar ao topo

UserForDashboad

Nome do atributo Descrição
TotalPublicVideos : int
TotalPrivateVideos : int
TotalPublicPlaylist : int
TotalPrivatePlaylist : int
TotalComments : int
TotalFavorites : int
Voltar ao topo

Video

Nome do atributo Descrição
Id : int
Active : int
CreationDate : string
Length : int
Pending : int (opcional)
Randname : string (opcional)
Subtitle : string
Synopse : string
Title : string
Username : string (opcional)
URL : string
Thumbnail : string
Embed : string
Rating : string
Views : string
Comments : string
ReferedExternal : string
Tags : string (opcional)
CommentsContent : ArrayOfComment (opcional)
CategoryId : int (opcional)
HD : int (opcional)
CanPublish : int (opcional)
CanShare : int (opcional)
ResultTotalVideos : int (opcional)
Token : string (opcional)
Voltar ao topo

VideoSubmition

Nome do atributo Descrição
Subtitle : string
Synopse : string
Title : string
Active : int
FileName : string (opcional)
Randname : string (opcional)
Tags : string
ReferedExternal : string (opcional)
CategoryId : int (opcional)
HD : int (opcional)
CanPublish : int (opcional)
CanShare : int (opcional)
PublishDate : string (opcional)
RemovalDate : string (opcional)
Voltar ao topo

Autenticação da API REST

Autenticação de um pedido REST

Cada pedido deverá conter informação de autenticação para estabelecer a identidade de quem fez o pedido e o token de autorização chamado ESB AccessKey (chave de acesso).

ESB Access Key

A autorização do uso da API é efectuada através da chave de acesso (ESB Access Key) que é disponibilizada no final do processo de compra do produto. Poderá gerar uma ESB Access Key para utilização da API nos detalhes do producto disponível na sua área de cliente.

O elemento ESBAccessKey deverá estar presente no URL como query-string

Exemplo HTTP GET usando nome do utilizador e palavra-chave:

Exemplo HTTP POST usando nome do utilizador e palavra-chave:

Request with ESBToken

Using a token instead of your username and password can be useful if you don't want to give your credentials to whom is using the API.

In order to generate a ESB Token you must use SAPO Security Token Service. You can generate a revocable token or a temporary token valid for 12 hours.

Exemplo HTTP GET usando um ESB Token:

Exemplo HTTP POST usando um ESB Token:

Descrição dos parâmetros:

ESBCredentials são parâmetros usados para autenticar e autorizar o pedido REST.

Elemento Descrição
ESBUsername O email da conta usada para para acederà API.
ESBPassword A palavra-passe que corresponde à conta de email especificada em ESBUsername.
ESBToken O token de acesso que representa as credenciais (ESBUsername + ESBPassword) usadas para comprar o uso da API.
ESBAccessKey O token que vai autorizar o pedido. A conta utilizada deve estar associada a este token.
Voltar ao topo

Autenticação da API SOAP

Autenticação de um pedido SOAP

Cada pedido deverá conter informação de autenticação para estabelecer a identidade de quem fez o pedido e o token de autorização chamado ESB AccessKey (chave de acesso).

ESB Access Key

Inserir caminho para obter a chave de acesso.

A autorização do uso da API é efectuada através da chave de acesso (ESBAccessKey) que é disponibilizada no final do processo de compra do produto.

Na sua área de cliente encontrará nos detalhes do produto a geração de chaves de acesso que podem ser geradas para si, para outros utilizadores da API registados no SAPO Services ou então por qualquer utilizador.

O elemento "ESBAccessKey" deverá aparecer num SOAP Header da mensagem após o SOAP Header "ESBCredentials".

Exemplo:

ESBCredentials

ESBCredentials é um tipo complexo que é usado para passar as credenciais de modo a autenticar o pedido SOAP.

Elemento Descrição
ESBUsername O email da conta usada para para acederà API.
ESBPassword A palavra-passe que corresponde à conta de email especificada em ESBUsername.
ESBToken O token de acesso que representa as credenciais (ESBUsername + ESBPassword) usadas para comprar o uso da API.

Pedido com ESBUsername e ESBPassword

Pedido com ESBToken

Usar um ESBToken ao invés do ESBUsername e ESBPassword pode ser útil se não pretende dar as suas credenciais a quem está a usar a API.

Para gerar um ESBToken deverá usar o serviço SAPO STS (Security Token Service). O ESB Token é válido por 12 horas.

Obter um ESB Token:

Resposta:

Token: id42ho234iwh234odihwdw786576413a3836467b94f8c2991f(...)wdwqdqwd

Voltar ao topo