Photos

Photos

O SAPO Fotos é um serviço de imagens totalmente gratuito, destinado ao alojamento, gestão e partilha de fotografias com amigos e parentes.

Subscrição gratuita

Descrição Técnica

Serviço Fotos

Pesquisa de fotos. Neste serviço é possível pesquisar fotos de um utilizador, uma tag, ou simultaneamente de ambos. Permite ainda a pesquisa de fotos de um álbum de um utilizador.

Manual de Referência da API

Serviço Operação Descrição
Fotos AlbumCreate Cria um álbum na plataforma do Fotos.
AlbumGetListByCollection Devolve uma lista de álbuns de um determinado conjunto.
AlbumGetListByHighlighted Devolve uma lista de álbuns em destaque para um dado interface (o default é fotos.sapo.pt).
AlbumGetListByUser Devolve uma lista de álbuns de um determinado utilizador (álbum especial 'Ao Molho', assim como os restantes, com excepção do álbum 'Favoritos' que terá métodos próprios).
CollectionGetListByUser Devolve uma lista de conjuntos de um dado Utilizador.
DummyEcho Fornece um eco, para efeitos de teste. Deve ser utilizado para testar o acesso à API em produção. Se o parâmetro opcional for especificado, é adicionado ao timestamp devolvido no resultado.
ImageAddToAlbum Adiciona uma imagem a um ou mais álbuns do mesmo utilizador.
ImageCreate

Cria uma imagem na plataforma do Fotos.

O carregamento de uma imagem através da API do Fotos é um processo de dois passos.

  • Primeiro é necessário invocar o método ImageCreate com a meta-informação correspondente à imagem. Este método retorna, para além de mais informação específica da plataforma relacionada com a imagem, um token que terá de ser utilizado como o parâmetro 'token' no passo 2.
  • Segundo é necessário fazer uma chamada POST a http://fotos.sapo.pt/uploadPost.html, juntamente com o ficheiro da imagem. O TTL deste token é de 10 minutos, o que deverá ser tempo mais que suficiente para completar todo o processo. O ficheiro a ser enviado via POST não carece de um nome específico para o seu input type file; pode ser utilizado qualquer um.
ImageDelete Remove uma imagem do serviço
ImageDetails Detalhes de metadados da imagem.
ImageEdit Edita uma imagem na plataforma do Fotos. Invocar o método ImageEdit com a meta-informação correspondente à imagem. Este método retorna imagem com a meta-informação actualizada para a que foi enviada pelo utilizador.
ImageGetListBySearch Pesquisa na base de dados do Fotos por imagens relacionadas com os termos de pesquisa.
ImageGetListByTags Devolve uma lista de imagens marcadas com as tags indicadas. É ainda possível especificar um utilizador para essa lista, especificar acesso para maiores de 18 e também a ordem da lista.
ImageGetListByUser Devolve uma lista de imagens de um determinado utilizador.
ImageGetListByUserAlbum Retorna uma lista de imagens para um par utilizador/álbum específico.
ImageNotifyView Notifica a plataforma de que uma visualização de imagem acabou de ocorrer. São necessárias permissões de administrador.
ImageRemoveFromAlbum Remove uma imagem de uma dada lista de àlbuns.
JSON Pesquisa de fotos públicas classificadas com a expressão “sol” no formato JSON
RSS Pesquisa de fotos públicas classificadas com a expressão “sol” no formato RSS
TagsGetListByHighlighted Retorna a lista actual de tags em destaque
UserCreate Cria um utilizador na plataforma SAPO Fotos
UserDetails Devolve detalhes da conta de um utilizador na plataforma do Fotos.
UserGetListByHighlighted Devolve a lista de utilizadores em destaque para um dado interface (o default é: fotos.sapo.pt).
UserGetTags Devolve uma lista de tags utilizadas por um determinado utilizador.

Serviço Fotos

Operações

AlbumCreate

Cria um álbum na plataforma do Fotos.
Parâmetros do pedido
album : Album (mandatório)
Parâmetros de resposta
AlbumCreateResult : AlbumCreateResult (mandatório)

Devolve no resultado uma instância do tipo Album.

Este método devolve já o url para o álbum, assim como o link para a futura capa.

Voltar ao topo

AlbumGetListByCollection

Devolve uma lista de álbuns de um determinado conjunto.
Parâmetros do pedido
collection : Collection (mandatório)
page : int (opcional)
orderBy : string (opcional)
Parâmetros de resposta
AlbumGetListByCollectionResult : AlbumGetListByCollectionResult (mandatório)

Devolve no resultado uma instância do tipo ArrayOfAlbums.

Este método não devolve quaisquer informações acerca das imagens contidas nos álbuns devolvidos.

Voltar ao topo

AlbumGetListByHighlighted

Devolve uma lista de álbuns em destaque para um dado interface (o default é fotos.sapo.pt).
Parâmetros do pedido
page : int (opcional)

O número da página a obter (1-based).

orderBy : string (opcional)

O campo de ordenação, pode tomar os valores seguintes:

  • alfabeticamente
  • alfabeticamente-inversa
  • maisantigas (para fotos)
  • maisantigos (para álbuns, conjuntos)
  • maisrecentes
  • relevancia
  • id (identificador)
intf : string (opcional)

Interface para o qual se pretende obter os destaques (default: fotos.sapo.pt)

Parâmetros de resposta
AlbumGetListByHighlightedResult : AlbumGetListByHighlightedResult (mandatório)

Devolve no resultado uma instância do tipo ArrayOfAlbums.

Este método não devolve quaisquer informações acerca das imagens contidas nos álbuns devolvidos.

Voltar ao topo

AlbumGetListByUser

Devolve uma lista de álbuns de um determinado utilizador (álbum especial 'Ao Molho', assim como os restantes, com excepção do álbum 'Favoritos' que terá métodos próprios).
Parâmetros do pedido
user : User (mandatório)

Não é necessário preencher este parâmetro, caso o utilizador das credenciais seja o dono do álbum.

page : int (opcional)

O número da página a obter (1-based).

orderBy : string (opcional)

O campo de ordenação, pode tomar os valores seguintes:

  • alfabeticamente
  • alfabeticamente-inversa
  • maisantigas (para fotos)
  • maisantigos (para álbuns, conjuntos)
  • maisrecentes
  • relevancia
  • id (identificador)
interface : string (opcional)

Interface para o qual se pretende obter os destaques (default: fotos.sapo.pt)

Parâmetros de resposta
AlbumGetListByUserResult : AlbumGetListByUserResult (mandatório)

Devolve no resultado uma instância do tipo ArrayOfAlbums.

Este método não devolve quaisquer informações acerca das imagens contidas nos álbuns devolvidos.

Voltar ao topo

CollectionGetListByUser

Devolve uma lista de conjuntos de um dado Utilizador.
Parâmetros do pedido
user : User (mandatório)
Apenas é necessário preencher o username.
page : int (opcional)

O número da página a obter (1-based).

orderBy : string (opcional)

O campo de ordenação, pode tomar os valores seguintes:

  • alfabeticamente
  • alfabeticamente-inversa
  • maisantigas (para fotos)
  • maisantigos (para álbuns, conjuntos)
  • maisrecentes
  • relevancia
  • id (identificador)
Parâmetros de resposta
CollectionGetListByUserResult : CollectionGetListByUserResult (mandatório)

Devolve no resultado uma instância do tipo ArrayOfCollections.

Voltar ao topo

DummyEcho

Fornece um eco, para efeitos de teste. Deve ser utilizado para testar o acesso à API em produção. Se o parâmetro opcional for especificado, é adicionado ao timestamp devolvido no resultado.
Parâmetros do pedido
echoStr : string (opcional)

Recebe uma string como parâmetro opcional.

Parâmetros de resposta
DummyEchoResult : string (mandatório)

Devolve uma string com um timestamp e o texto enviado como parâmetro de entrada.

Voltar ao topo

ImageAddToAlbum

Adiciona uma imagem a um ou mais álbuns do mesmo utilizador.
Parâmetros do pedido
image : Image (mandatório)

Deverão ser especificados tantos álbuns quantos os que se quer adicionar à imagem. Deverão obrigatoriamente ser preenchidos os atributos 'Image::uid' e 'Album::id'.

interface : string (opcional)

Interface para o qual se pretende obter os destaques (default: fotos.sapo.pt)

Parâmetros de resposta
ImageAddToAlbumResult : ImageAddToAlbumResult (mandatório)

Retorna apenas o tipo result.

Voltar ao topo

ImageCreate

Cria uma imagem na plataforma do Fotos.

O carregamento de uma imagem através da API do Fotos é um processo de dois passos.

  • Primeiro é necessário invocar o método ImageCreate com a meta-informação correspondente à imagem. Este método retorna, para além de mais informação específica da plataforma relacionada com a imagem, um token que terá de ser utilizado como o parâmetro 'token' no passo 2.
  • Segundo é necessário fazer uma chamada POST a http://fotos.sapo.pt/uploadPost.html, juntamente com o ficheiro da imagem. O TTL deste token é de 10 minutos, o que deverá ser tempo mais que suficiente para completar todo o processo. O ficheiro a ser enviado via POST não carece de um nome específico para o seu input type file; pode ser utilizado qualquer um.
Parâmetros do pedido
image : Image (mandatório)

Não é obrigatório o preenchimento de quaisquer atributos, embora seja boa ideia preencher pelo menos os seguintes:

  • title
  • synopse
  • tags (por enquanto quaisquer 'space', ';' ou ',' separam as tags - para usar várias palavras na mesma tag, usar underscore '_')
interface : string (opcional)

Interface para o qual se pretende obter os destaques (default: fotos.sapo.pt)

Parâmetros de resposta
ImageCreateResult : ImageCreateResult (mandatório)

Devolve uma instância do tipo Image com mais meta-info acerca da imagem e também uma string com um token. Este último deverá ser utilizado para completar o processo de upload.

Exemplos

Chamada POST do segundo passo de criação de uma imagem

O parâmetro "redir" é opcional.

Se for especificado nesta chamada POST um URL no parâmetro 'redir', ao invés de ser devolvido XML, será invocado esse URL, para onde será enviado via GET o identificador do resultado da chamada, no atributo 'status'.

Segue-se a tipificação dos identificadores de resultados:

Identificador Descrição Observações
INVALID_UPLOAD Invalid upload, possibly max upload size of xxxxx bytes exceeded
MISSING_TOKEN Missing token from POST vars não foi enviado nada no atributo 'token'
INVALID_TOKEN Invalid token o token enviado via POST é inválido
INVALID_IMAGE Invalid image referenced by token
INVALID_OWNER Invalid owner, user is probably banned
EXHAUSTED_TOKEN Token exhausted o token já foi utilizado
NO_FILE No file was sent não foi enviado um ficheiro de imagem
FILE_COUNT_EXCEEDED Only allowed to upload one file at a time foi enviado mais que um ficheiro de imagem
INVALID_FILE Invalid file for upload o ficheiro enviado não é válido (não tem a ver com formatos da imagem, mas sim com a correcta formatação do request e do ficheiro no envio)
FILE_LIMIT_QUOTA_EXCEEDED User exceeded maximum allowed total of images of xxxx
FILE_SIZE_QUOTA_EXCEEDED User exceeded file quota size of xxxx
TOTAL_STORAGE_QUOTA_EXCEEDED User exceeded total storage quota of xxxx
INVALID_DIMENSIONS File does not fulfill minimum dimensions requirements of ??x??
PROBLEMS_SAVING_IMAGE Problems saving image. Contact the tech support houve um erro ao gerar uma ou mais dimensões da imagem original. É possível que a mesma esteja em estado de erro na plataforma
SUCCESS sucesso

Segue-se um exemplo de código HTML para o segundo passo do carregamento de uma imagem através da API do Fotos (upload da imagem), em que o parâmetro "redir" - como indicado acima - é opcional.

Formato do XML de resposta

Em caso de sucesso: Em caso de erro:
Voltar ao topo

ImageDelete

Remove uma imagem do serviço
Parâmetros do pedido
image : Image (mandatório)

Deverá obrigatoriamente ser preenchido o atributo 'Image::uid'.

Parâmetros de resposta
ImageDeleteResult : Result (mandatório)
Voltar ao topo

ImageDetails

Detalhes de metadados da imagem.
Parâmetros do pedido
image : Image (mandatório)

Deverá obrigatoriamente ser preenchido o atributo 'Image::uid'.

Parâmetros de resposta
ImageDetailsResult : ImageDetailsResult (mandatório)
Um objecto do tipo Image, preenchido com os restantes detalhes da imagem.
Voltar ao topo

ImageEdit

Edita uma imagem na plataforma do Fotos. Invocar o método ImageEdit com a meta-informação correspondente à imagem. Este método retorna imagem com a meta-informação actualizada para a que foi enviada pelo utilizador.
Parâmetros do pedido
image : Image (mandatório)

É necessário ter o campo 'Image::uid' preenchido como modo de identificação da imagem a editar. Não é obrigatório o preenchimento de quaisquer outros atributos.

Os campos disponíveis para actualização são os seguintes:

  • Image::title
  • Image::active
  • Image::password
  • Image::m18
  • Image::synopse
  • Image::tags (por enquanto quaisquer 'space', ';' ou ',' separam as tags - para usar várias palavras na mesma tag, usar underscore '_')
Parâmetros de resposta
ImageEditResult : ImageEditResult (mandatório)

Devolve no resultado uma instância do tipo Image com a meta-info actualizada.

NOTA: A meta-informação da imagem vai ser substituida pela meta-informação enviada no parâmetro de entrada, pelo que se deve ter em atenção que campos deixados em branco irão remover qualquer informação que existisse anteriormente.

Voltar ao topo

ImageGetListBySearch

Pesquisa na base de dados do Fotos por imagens relacionadas com os termos de pesquisa.
Parâmetros do pedido
page : int (opcional)

O número da página a obter (1-based).

interface : string (opcional)

Interface para o qual se pretende obter os destaques (default: fotos.sapo.pt)

terms : ArrayOfStrings (mandatório)
Uma ou mais strings para pesquisa na descrição/tags.
dateFrom : string (opcional)

Data limite inferior para pesquisa por data.

Formato: é aconselhado usar aaaa-mm-dd, mas são suportados todos os formatos da função strtotime do PHP (http://www.php.net/strtotime).

dateTo : string (opcional)

Data limite superior para pesquisa por data.

Formato: é aconselhado usar aaaa-mm-dd, mas são suportados todos os formatos da função strtotime do PHP.

Parâmetros de resposta
ImageGetListBySearchResult : ImageGetListBySearchResult (mandatório)
Devolve no resultado uma instância do tipo ArrayOfImages.
Voltar ao topo

ImageGetListByTags

Devolve uma lista de imagens marcadas com as tags indicadas. É ainda possível especificar um utilizador para essa lista, especificar acesso para maiores de 18 e também a ordem da lista.
Parâmetros do pedido
tags : ArrayOfTags (mandatório)
Um array com as tags.
page : int (opcional)
O número da página a obter (1-based).
orderBy : string (opcional)

O campo de ordenação, pode tomar os valores seguintes:

  • alfabeticamente
  • alfabeticamente-inversa
  • maisantigas (para fotos)
  • maisantigos (para álbuns, conjuntos)
  • maisrecentes
  • relevancia
  • id (identificador)
m18 : boolean (opcional)
user : User (opcional)
Preencher o user::username para obter imagens com as tags desse user.
interface : string (opcional)
Interface para o qual se pretende obter os destaques (default: fotos.sapo.pt)
Parâmetros de resposta
ImageGetListByTagsResult : ImageGetListByTagsResult (mandatório)
Voltar ao topo

ImageGetListByUser

Devolve uma lista de imagens de um determinado utilizador.
Parâmetros do pedido
page : int (opcional)
O número da página a obter (1-based).
user : User (mandatório)
Não é necessário preencher este parâmetro, caso o utilizador das credenciais seja o próprio user.
Parâmetros de resposta
ImageGetListByUserResult : ImageGetListByUserResult (mandatório)
Devolve no resultado uma instância do tipo ArrayOfImages.
Voltar ao topo

ImageGetListByUserAlbum

Retorna uma lista de imagens para um par utilizador/álbum específico.
Parâmetros do pedido
user : User (mandatório)
Não é necessário preencher este parâmetro, caso o utilizador das credenciais seja o dono do álbum.
album : Album (mandatório)
page : int (opcional)
The page number to obtain (1-based).
interface : string (opcional)
Interface para o qual se pretende obter os destaques (default: fotos.sapo.pt)
orderBy : string (opcional)

O campo de ordenação, pode tomar os valores seguintes:

  • alfabeticamente
  • alfabeticamente-inversa
  • maisantigas (para fotos)
  • maisantigos (para álbuns, conjuntos)
  • maisrecentes
  • relevancia
  • id (identificador)
Parâmetros de resposta
ImageGetListByUserAlbumResult : ImageGetListByUserAlbumResult (mandatório)
Devolve no resultado uma instância do tipo ArrayOfImages.
Voltar ao topo

ImageNotifyView

Notifica a plataforma de que uma visualização de imagem acabou de ocorrer. São necessárias permissões de administrador.
Parâmetros do pedido
value : int (mandatório)
type : string (opcional)
image : Image (mandatório)
Parâmetros de resposta
ImageNotifyViewResult : ImageNotifyViewResult (mandatório)
Voltar ao topo

ImageRemoveFromAlbum

Remove uma imagem de uma dada lista de àlbuns.
Parâmetros do pedido
image : Image (mandatório)
Deverão ser especificados tantos álbuns quantos os que se quer remover da imagem, no máximo 50. Deverão obrigatoriamente ser preenchidos os atributos 'Image::uid' e 'Album::id'.
Parâmetros de resposta
ImageRemoveFromAlbumResult : Result (mandatório)
Voltar ao topo

JSON

Pesquisa de fotos públicas classificadas com a expressão “sol” no formato JSON
Exemplos

Pesquisa de fotos públicas classificadas com a expressão “sol” no formato JSON

Pesquisa de fotos públicas do utilizador “celso” no formato JSON

Pesquisa de fotos públicas do utilizador “celso” classificadas com a expressão “jobs” no formato JSON
Voltar ao topo

RSS

Pesquisa de fotos públicas classificadas com a expressão “sol” no formato RSS
Exemplos

Pesquisa de fotos públicas classificadas com a expressão “sol” no formato RSS

Pesquisa de fotos públicas do utilizador “celso” no formato RSS

Pesquisa de fotos públicas do utilizador “celso” classificadas com a expressão “jobs” no formato RSS

Pesquisa de fotos públicas no formato RSS

Pesquisa de fotos públicas do utilizador “celso” com paginação no formato RSS
Voltar ao topo

TagsGetListByHighlighted

Retorna a lista actual de tags em destaque
Parâmetros do pedido
intf : string (opcional)
Parâmetros de resposta
TagsGetListByHighlightedResult : TagsGetListByHighlightedResult (opcional)
Voltar ao topo

UserCreate

Cria um utilizador na plataforma SAPO Fotos
Parâmetros do pedido
user : User (mandatório)
Parâmetros de resposta
UserCreateResult : UserCreateResult (mandatório)

Devolve no resultado uma instância do tipo User.

No resultado vem já o link para a página de perfil e o link para o avatar.

Voltar ao topo

UserDetails

Devolve detalhes da conta de um utilizador na plataforma do Fotos.
Parâmetros do pedido
user : User (mandatório)
Não é necessário preencher este parâmetro, caso o utilizador das credenciais seja o utilizador prentendido.
interface : Format (opcional)
Interface para o qual se pretende obter os destaques (default: fotos.sapo.pt)
Parâmetros de resposta
UserDetailsResult : UserDetailsResult (mandatório)
Devolve no resultado uma instância do tipo User.
Voltar ao topo

UserGetListByHighlighted

Devolve a lista de utilizadores em destaque para um dado interface (o default é: fotos.sapo.pt).
Parâmetros do pedido
page : int (opcional)
O número da página a obter (1-based).
orderBy : string (opcional)

O campo de ordenação, pode tomar os valores seguintes:

  • alfabeticamente
  • alfabeticamente-inversa
  • maisantigas (para fotos)
  • maisantigos (para álbuns, conjuntos)
  • maisrecentes
  • relevancia
  • id (identificador)
intf : string (opcional)
Interface para o qual se pretende obter os destaques (default: fotos.sapo.pt)
Parâmetros de resposta
UserGetListByHighlightedResult : UserGetListByHighlightedResult (mandatório)
Devolve no resultado uma instância do tipo ArrayOfUser.
Voltar ao topo

UserGetTags

Devolve uma lista de tags utilizadas por um determinado utilizador.
Parâmetros do pedido
user : User (mandatório)
Não é necessário preencher este parâmetro, caso o utilizador das credenciais seja o utilizador pretendido.
interface : string (opcional)
Interface para o qual se pretende obter os destaques (default: fotos.sapo.pt)
Parâmetros de resposta
UserGetTagsResult : UserGetTagsResult (mandatório)

Devolve no resultado uma instância do tipo ArrayOfTags.

A listagem de tags não tem qualquer tipo de ordenação.

Voltar ao topo

Fotos Entidades

Album

Nome do atributo Descrição
id : int (opcional)
ownerId : int (opcional)
active : boolean (opcional)
password : string (opcional)
creationDate : string (opcional)
description : string (opcional)
title : string (opcional)
url : string (opcional)
user : User (opcional)
cover : string (opcional)
Voltar ao topo

AlbumCreateResult

Nome do atributo Descrição
result : Result
album : Album (opcional)
Voltar ao topo

AlbumGetListByCollectionResult

Nome do atributo Descrição
result : Result
albums : ArrayOfAlbums (opcional)
Voltar ao topo

AlbumGetListByHighlightedResult

Nome do atributo Descrição
result : Result
albums : ArrayOfAlbums (opcional)
Voltar ao topo

AlbumGetListByUserResult

Nome do atributo Descrição
albums : ArrayOfAlbums (opcional)
result : Result
Voltar ao topo

ArrayOfAlbums

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

ArrayOfCollections

Nome do atributo Descrição
Lista de collection : Collection
Voltar ao topo

ArrayOfComments

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

ArrayOfImages

Nome do atributo Descrição
Lista de image : Image
Voltar ao topo

ArrayOfStrings

Nome do atributo Descrição
Lista de string : string
Voltar ao topo

ArrayOfTags

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

ArrayOfUsers

Nome do atributo Descrição
Lista de user : User
Voltar ao topo

ArrayOfViews

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

Collection

Objecto para representar um conjunto
Nome do atributo Descrição
id : int (opcional)
active : boolean (opcional)
creationDate : string (opcional)
description : string (opcional)
title : string (opcional)
user : User (opcional)
code : string (opcional)
cover : string (opcional)
url : string (opcional)
Voltar ao topo

CollectionGetListByUserResult

Nome do atributo Descrição
result : Result
collections : ArrayOfCollections (opcional)
Voltar ao topo

Color

Nome do atributo Descrição
red : int
green : int
blue : int
Voltar ao topo

Comment

Nome do atributo Descrição
date : string
nickname : string
website : string
body : string
Voltar ao topo

Format

Valor Descrição
jpeg
jpg
bmp
gif
png
tiff
tif
Voltar ao topo

Image

Nome do atributo Descrição
id : int (opcional)
active : boolean (opcional)
password : string (opcional)
creationDate : string (opcional)
pending : boolean (opcional)
uid : string (opcional)
subtitle : string (opcional)
synopse : string (opcional)
title : string (opcional)
url : string (opcional)
rating : string (opcional)
tags : string (opcional)
comments : ArrayOfComments (opcional)
m18 : boolean (opcional)
innapropriate : boolean (opcional)
format : Format (opcional)
albums : ArrayOfAlbums (opcional)
user : User (opcional)
emailFrom : string (opcional)
visualizations : int (opcional)
views : ArrayOfViews (opcional)
refColor : Color (opcional)
avgColor : Color (opcional)
Voltar ao topo

ImageAddToAlbumResult

Nome do atributo Descrição
result : Result
Voltar ao topo

ImageCreateResult

Nome do atributo Descrição
token : string (opcional)
image : Image (opcional)
result : Result
Voltar ao topo

ImageDetailsResult

Nome do atributo Descrição
result : Result
image : Image (opcional)
Voltar ao topo

ImageEditResult

Nome do atributo Descrição
result : Result
image : Image (opcional)
Voltar ao topo

ImageGetListBySearchResult

Nome do atributo Descrição
result : Result
images : ArrayOfImages (opcional)
Voltar ao topo

ImageGetListByTagsResult

Nome do atributo Descrição
result : Result
images : ArrayOfImages (opcional)
Voltar ao topo

ImageGetListByUserAlbumResult

Nome do atributo Descrição
result : Result
images : ArrayOfImages (opcional)
Voltar ao topo

ImageGetListByUserResult

Resultado para o método ImageGetListByUser
Nome do atributo Descrição
result : Result
images : ArrayOfImages (opcional)
Voltar ao topo

ImageNotifyViewResult

Nome do atributo Descrição
result : Result
Voltar ao topo

Result

Object for pagination help

Nome do atributo Descrição
total : int (opcional) O número total de itens existentes no server-side - não é o número total de itens retornados no resultado.
page : int (opcional) A página do resultado devolvido, onde aplicável.
totalPages : int (opcional) O total de páginas para o universo de resultados existente no server-side.
perPage : int (opcional) O número de itens por página.
ok : boolean Especifica o sucesso ou o fracasso do resultado.
description : string (opcional) Tipicamente utilizado para descrições de situações de erro.
Voltar ao topo

TagsGetListByHighlightedResult

Nome do atributo Descrição
result : Result (opcional)
tags : ArrayOfTags (opcional)
Voltar ao topo

User

Nome do atributo Descrição
id : int (opcional)
active : boolean (opcional)
banned : boolean (opcional)
commentCaptcha : boolean (opcional)
commentModerate : boolean (opcional)
commentNotify : boolean (opcional)
creationDate : string (opcional)
email : string (opcional)
lastLogin : string (opcional)
partner : boolean (opcional)
uploadMail : string (opcional)
username : string (opcional)
viewAll : boolean (opcional)
avatar : string (opcional)
url : string (opcional)
imageCount : int (opcional)
albumCount : int (opcional)
Voltar ao topo

UserCreateResult

Nome do atributo Descrição
result : Result
user : User (opcional)
Voltar ao topo

UserDetailsResult

Nome do atributo Descrição
result : Result
user : User (opcional)
Voltar ao topo

UserGetListByHighlightedResult

Nome do atributo Descrição
result : Result
users : ArrayOfUsers (opcional)
Voltar ao topo

UserGetTagsResult

Nome do atributo Descrição
tags : ArrayOfTags (opcional)
result : Result
Voltar ao topo

View

Nome do atributo Descrição
actualWidth : int (opcional)
actualHeight : int (opcional)
requestWidth : int (opcional)
requestHeight : int (opcional)
url : string
size : string
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