Cartaz de Cinema

Cartaz de Cinema

Todos as sessões, todas as salas, todos os filmes em exibição no país.

Comprar produto  

Descrição Técnica

Serviço GIS

Operações relacionadas com a obtenção de pontos de interesse dando alguns parâmetros: coordenadas geográficas, texto livre, um local, um código postal, número de telefone, etc.

Serviço Cinema

Procurar cartaz por filme, cinema, localização e outros filtros. Consultar datas de estreias dos próximos filmes e informação detalhada sobre filmes, cinemas, pessoas e outros dados relacionados.

Acerca dos elementos Filme:

- incluem um elemento Release com os dados relativos ao lançamento num determinado país (por defeito é Portugal, mas pode ser alterado fornecendo um ReleaseCountryId)

Manual de Referência da API

Serviço Operação Descrição
Cinema GetContributorRoles Listar tipos de contribuições. Parâmetros: PageNumber (optional, defaults to 1); RecordsPerPage (optional, defaults to 0);
GetCountryAuthority Consultar detalhes da autoridade de um determinado país, incluindo a lista de classificações que atribui aos filmes. Parâmetro: CountryId (Sapo GIS CountryId);
GetGenres Consultar lista de géneros de filmes. Parâmetros: PageNumber (optional, defaults to 1), RecordsPerPage (optional, defaults to 10);
GetMoviePremieres Listar filmes com dados de estreia. Parâmetros: ReleaseCountryId (optional, default = PT); StartDate (ex. 2009-07-01, optional, default = start of current week, Sunday 00:00); EndDate (2009-07-01, optional, default = end of current week, Saturday 23:59); ProductionCountryIds (optional, ex. PT,ES); GenreIds (optional, ex. 2,3); ReleaseRatingIds (optional, ex. M04,M18); PageNumber (optional, default = 1); RecordsPerPage (optional, default = 10)
GetMoviesWithShowTimes Listar filmes com horários de exibição dentro dos locais e período de tempo. Parâmetros: ReleaseCountryId (optional, default = PT); LocationIds (optional, must be within ReleaseCountry, ex. 11,13); StartDate (2009-07-10, optional, default = last Thursday); EndDate (2009-07-01, optional, default = next Thursday); ProductionCountryIds (optional, ex. ES,PT); GenreIds (optional, ex. 2,3); ReleaseRatingIds (optional, ex. M04, M18); PageNumber (optional, default = 1); RecordsPerPage (optional, default = 10);
GetPersons Listar filmes de acordo com os filtros (paginado). IncludeReleaseWithCountryId default = PT; PageNumber default = 1; RecordsPerPage default = 10, Max itens = 20;
GetTheaters Lista de salas de cinema na localização, com quantidade de filmes em exibição.
GetTheatersWithShowTimes Listar filmes dentro dos locais com horários de exibição dentro do período de tempo. Parâmetros: ReleaseCountryId (optional, default = PT); LocationIds (optional, must be within ReleaseCountry, ex. 11,13); StartDate (2009-01-01, optional, default = last Thursday); EndDate (2009-09-01, optional, default = next Thursday), ProductionCountryIds (optional, ex. ES,PT); GenreIds (optional, ex. 2,3); ReleaseRatingIds (optional, ex. M04, M18); PageNumber (optional, default = 1); RecordsPerPage (optional, default = 10)
GIS GetCategories Devolve uma lista de categorias
GetCategoriesByTag Devolve uma lista de categorias dada uma tag
GetCountries Retorna uma lista com todos os países existentes no sistema.
GetDistrictById Devolve os dados de um distrito dado um id
GetDistrictsSortedById Devolve uma lista de distritos ordenados pelo id
GetDistrictsSortedByName Devolve uma lista de distritos ordenados pelo nome
GetLanguages Devolve as linguagens presentes no sistema, no esquema IETF language tag.
GetLastPOIs Devolve os últimos POIs registados.
GetLastPOIsByCategoryId Devolve os últimos POIs registados, dado um id duma categoria
GetMatchLevels Retorna uma lista dos níveis de "match" disponíveis (i.e. precisão da georreferenciação)
GetMunicipalitiesByDistrictIdSortedById Devolve uma lista de municípios dado um distrito, ordenados por id
GetMunicipalitiesByDistrictIdSortedByName Devolve uma lista de municípios dado um distrito, ordenados por nome
GetMunicipalitiesSortedById Devolve uma lista de municípios ordenados por id
GetMunicipalitiesSortedByName Devolve uma lista de municípios ordenados por nome
GetMunicipalityById Devolve os dados de um município dado um id
GetNeighborDistricts Devolve uma lista de distritos limítrofes
GetNeighborMunicipalities Devolve uma lista de concelhos limítrofes
GetNeighborParishes Devolve uma lista de freguesias limítrofes
GetParishById Devolve os dados de uma freguesia dado um id
GetParishesByMunicipalityIdSortedById Devolve uma lista de freguesias dado um município, ordenadas por id
GetParishesByMunicipalityIdSortedByName Devolve uma lista de freguesias dado um município, ordenadas por nome
GetParishesSortedById Devolve uma lista de freguesias ordenadas por id
GetParishesSortedByName Devolve uma lista de freguesias ordenadas por name
GetPOIByBoundingBox Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dadas as coordenadas dos cantos, inferior esquerdo e superior direito, de um rectangulo e, opcionalmente, uma categoria.
GetPOIByBoundingBoxAndCategoryIdAndText Retorna uma lista de POIs dado uma àrea, o id de uma categoria e uma descrição textual. Opcionalmente o resultado pode ser filtrado pelo nivel de confiança e/ou pelo nivel de georeferenciação, se os seus valores forem especificados.
GetPOIByCategoryIdAndSourceId Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dados um distrito e uma categoria
GetPOIByCategoryIdAndText Retorna uma lista de POIs dado o id de uma categoria e uma descrição textual. Opcionalmente o resultado pode ser filtrado pelo distrito e/ou pelo município, se os seus ids forem especificados.
GetPOIByCoordinates Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dadas as coordenadas
GetPOIByCoordinatesAndCategories Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dadas as coordenadas e um conjunto de categorias
GetPOIByCoordinatesAndCategoryId Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dadas as coordenadas e uma categoria
GetPOIByCoordinatesAndText Retorna uma lista de POIs, dados um par de coordenadas e uma descrição textual
GetPOIByDistrictId Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dado um distrito
GetPOIByDistrictIdAndCategoryId Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dados um distrito e uma categoria
GetPOIByDistrictIdAndText Devolve uma lista de POIs de um dado distrito, filtrados pelo texto especificado
GetPOIById Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dado um id
GetPOIByMunicipalityId Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dado um município
GetPOIByMunicipalityIdAndCategoryId Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dados um município e uma categoria
GetPOIByMunicipalityIdAndText Devolve uma lista de POIs de um dado concelho, filtrados pelo texto especificado
GetPOIByParishId Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dada uma freguesia
GetPOIByParishIdAndCategoryId Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dadas uma freguesia e uma categoria
GetPOIByParishIdAndText Devolve uma lista de POIs de uma dada freguesia, filtrados pelo texto especificado
GetPOIByPOISourceId Devolve um POI, dados o categoryId, sourceId e poiSourceId.
GetPOIByTags Devolve uma lista de POIs, dada uma lista de tags.
GetPOIByText Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dada uma expressão
GetTrustLevels Devolve uma lista com os níveis de confiança disponíveis. Estes níveis indicam o nível de qualidade da georreferenciação.

Serviço Cinema

GetContributorRoles

Listar tipos de contribuições. Parâmetros: PageNumber (optional, defaults to 1); RecordsPerPage (optional, defaults to 0);

Parâmetros do pedido

PageNumber : int (opcional)
RecordsPerPage : int (opcional)

Parâmetros de resposta

GetContributorRolesResult : ListOfContributorRoles (mandatório)

Listar tipos de contribuições. Parâmetros: PageNumber (optional, defaults to 1); RecordsPerPage (optional, defaults to 0);
Voltar ao topo

GetCountryAuthority

Consultar detalhes da autoridade de um determinado país, incluindo a lista de classificações que atribui aos filmes. Parâmetro: CountryId (Sapo GIS CountryId);

Parâmetros do pedido

CountryId : string (mandatório)

Parâmetros de resposta

GetCountryAuthorityResult : Authority (mandatório)

Consultar detalhes da autoridade de um determinado país, incluindo a lista de classificações que atribui aos filmes. Parâmetro: CountryId (Sapo GIS CountryId);
Voltar ao topo

GetGenres

Consultar lista de géneros de filmes. Parâmetros: PageNumber (optional, defaults to 1), RecordsPerPage (optional, defaults to 10);

Parâmetros do pedido

PageNumber : int (opcional)
RecordsPerPage : int (opcional)

Parâmetros de resposta

GetGenresResult : ListOfGenres (mandatório)

Consultar lista de géneros de filmes. Parâmetros: PageNumber (optional, defaults to 1), RecordsPerPage (optional, defaults to 10);
Voltar ao topo

GetMoviePremieres

Listar filmes com dados de estreia. Parâmetros: ReleaseCountryId (optional, default = PT); StartDate (ex. 2009-07-01, optional, default = start of current week, Sunday 00:00); EndDate (2009-07-01, optional, default = end of current week, Saturday 23:59); ProductionCountryIds (optional, ex. PT,ES); GenreIds (optional, ex. 2,3); ReleaseRatingIds (optional, ex. M04,M18); PageNumber (optional, default = 1); RecordsPerPage (optional, default = 10)

Parâmetros do pedido

ReleaseCountryId : string (opcional)
StartDate : date (opcional)
EndDate : date (opcional)
ProductionCountryIds : ArrayOfProductionCountryId (opcional)
GenreIds : ArrayOfGenreId (opcional)
ReleaseRatingIds : ArrayOfRatingId (opcional)
IncludeContributors : boolean (opcional)
IncludeSynopsis : boolean (opcional)
PageNumber : int (opcional)
RecordsPerPage : int (opcional)
Version : int (opcional)

Parâmetros de resposta

GetMoviePremieresResult : ListOfMovies (mandatório)

Listar filmes com dados de estreia. Parâmetros: ReleaseCountryId (optional, default = PT); StartDate (ex. 2009-07-01, optional, default = start of current week, Sunday 00:00); EndDate (2009-07-01, optional, default = end of current week, Saturday 23:59); ProductionCountryIds (optional, ex. PT,ES); GenreIds (optional, ex. 2,3); ReleaseRatingIds (optional, ex. M04,M18); PageNumber (optional, default = 1); RecordsPerPage (optional, default = 10)

Listar filmes com dados de estreia. Parâmetros: ReleaseCountryId (optional, default = PT); StartDate (ex. 2009-07-01, optional, default = start of current week, Sunday 00:00); EndDate (2009-07-01, optional, default = end of current week, Saturday 23:59); ProductionCountryIds (optional, ex. PT,ES); GenreIds (optional, ex. 2,3); ReleaseRatingIds (optional, ex. M04,M18); PageNumber (optional, default = 1); RecordsPerPage (optional, default = 10)
Voltar ao topo

GetMoviesWithShowTimes

Listar filmes com horários de exibição dentro dos locais e período de tempo. Parâmetros: ReleaseCountryId (optional, default = PT); LocationIds (optional, must be within ReleaseCountry, ex. 11,13); StartDate (2009-07-10, optional, default = last Thursday); EndDate (2009-07-01, optional, default = next Thursday); ProductionCountryIds (optional, ex. ES,PT); GenreIds (optional, ex. 2,3); ReleaseRatingIds (optional, ex. M04, M18); PageNumber (optional, default = 1); RecordsPerPage (optional, default = 10);

Parâmetros do pedido

ReleaseCountryId : string (opcional)
LocationIds : ArrayOfLocationId (opcional)
StartDate : date (opcional)
EndDate : date (opcional)
ProductionCountryIds : ArrayOfProductionCountryId (opcional)
GenreIds : ArrayOfGenreId (opcional)
ReleaseRatingIds : ArrayOfRatingId (opcional)
IncludeShowTimesDetails : boolean (opcional)
IncludeContributors : boolean (opcional)
IncludeSynopsis : boolean (opcional)
IncludeGenres : boolean (opcional)
Desativa mostrar detalhes do genero na ficha do filme
IncludeReferences : boolean (opcional)
IncludeRelease : boolean (opcional)
IncludeMedia : boolean (opcional)
Version : int (opcional)
Filtra filmes pelo versionId
PageNumber : int (opcional)
RecordsPerPage : int (opcional)

Parâmetros de resposta

GetMoviesWithShowTimesResult : ListOfMovies (mandatório)

Listar filmes com horários de exibição dentro dos locais e período de tempo. Parâmetros: ReleaseCountryId (optional, default = PT); LocationIds (optional, must be within ReleaseCountry, ex. 11,13); StartDate (2009-07-10, optional, default = last Thursday); EndDate (2009-07-01, optional, default = next Thursday); ProductionCountryIds (optional, ex. ES,PT); GenreIds (optional, ex. 2,3); ReleaseRatingIds (optional, ex. M04, M18); PageNumber (optional, default = 1); RecordsPerPage (optional, default = 10);
Voltar ao topo

GetPersons

Listar filmes de acordo com os filtros (paginado). IncludeReleaseWithCountryId default = PT; PageNumber default = 1; RecordsPerPage default = 10, Max itens = 20;

Parâmetros do pedido

BirthCountryId : string (opcional)
IncludeReleaseWithCountryId : string (opcional)
SearchTerms : string (opcional)
PageNumber : int (opcional)
RecordsPerPage : int (opcional)

Parâmetros de resposta

GetPersonsResult : ListOfPerson (mandatório)
Voltar ao topo

GetTheaters

Lista de salas de cinema na localização, com quantidade de filmes em exibição.

Parâmetros do pedido

ReleaseCountryId : string (mandatório)
LocationIds : ArrayOfLocationId (opcional)
PageNumber : int (opcional)
RecordsPerPage : int (mandatório)

Parâmetros de resposta

GetTheatersResult : ListOfTheaters (mandatório)
Voltar ao topo

GetTheatersWithShowTimes

Listar filmes dentro dos locais com horários de exibição dentro do período de tempo. Parâmetros: ReleaseCountryId (optional, default = PT); LocationIds (optional, must be within ReleaseCountry, ex. 11,13); StartDate (2009-01-01, optional, default = last Thursday); EndDate (2009-09-01, optional, default = next Thursday), ProductionCountryIds (optional, ex. ES,PT); GenreIds (optional, ex. 2,3); ReleaseRatingIds (optional, ex. M04, M18); PageNumber (optional, default = 1); RecordsPerPage (optional, default = 10)

Parâmetros do pedido

ReleaseCountryId : string (opcional)
LocationIds : ArrayOfLocationId (opcional)
StartDate : date (opcional)
EndDate : date (opcional)
ProductionCountryIds : ArrayOfProductionCountryId (opcional)
GenreIds : ArrayOfGenreId (opcional)
ReleaseRatingIds : ArrayOfRatingId (opcional)
IncludeShowTimeDetails : boolean (opcional)
IncludeLocation : boolean (opcional)
PageNumber : int (opcional)
RecordsPerPage : int (opcional)
Version : int (opcional)

Parâmetros de resposta

GetTheatersWithShowTimesResult : ListOfTheaters (mandatório)

Listar filmes dentro dos locais com horários de exibição dentro do período de tempo. Parâmetros: ReleaseCountryId (optional, default = PT); LocationIds (optional, must be within ReleaseCountry, ex. 11,13); StartDate (2009-01-01, optional, default = last Thursday); EndDate (2009-09-01, optional, default = next Thursday), ProductionCountryIds (optional, ex. ES,PT); GenreIds (optional, ex. 2,3); ReleaseRatingIds (optional, ex. M04, M18); PageNumber (optional, default = 1); RecordsPerPage (optional, default = 10)

Listar filmes dentro dos locais com horários de exibição dentro do período de tempo. Parâmetros: ReleaseCountryId (optional, default = PT); LocationIds (optional, must be within ReleaseCountry, ex. 11,13); StartDate (2009-01-01, optional, default = last Thursday); EndDate (2009, optional, default = next Thursday); ProductionCountryIds (optional, ex. Es,PT); GenreIds (optional, ex. 2,3); ReleaseRatingIds (optional, PT,ES); PageNumber (optional, default = 1), RecordsPerPage (optional, default = 10);
Voltar ao topo

Serviço GIS

GetCategories

Devolve uma lista de categorias

Parâmetros do pedido

includeDetails : boolean (opcional)

Parâmetros de resposta

GetCategoriesResult : ArrayOfCategory (opcional)
Voltar ao topo

GetCategoriesByTag

Devolve uma lista de categorias dada uma tag

Parâmetros do pedido

tag : string (opcional)

Parâmetros de resposta

GetCategoriesByTagResult : ArrayOfCategory (opcional)
Voltar ao topo

GetCountries

Retorna uma lista com todos os países existentes no sistema.

Parâmetros de resposta

GetCountriesResult : ArrayOfCountry (opcional)
Voltar ao topo

GetDistrictById

Devolve os dados de um distrito dado um id

Parâmetros do pedido

districtId : string (opcional)

Parâmetros de resposta

GetDistrictByIdResult : District (opcional)
Voltar ao topo

GetDistrictsSortedById

Devolve uma lista de distritos ordenados pelo id

Parâmetros do pedido

includeMunicipalities : boolean (opcional)

Parâmetros de resposta

GetDistrictsSortedByIdResult : ArrayOfDistrict (opcional)
Voltar ao topo

GetDistrictsSortedByName

Devolve uma lista de distritos ordenados pelo nome

Parâmetros do pedido

includeMunicipalities : boolean (opcional)

Parâmetros de resposta

GetDistrictsSortedByNameResult : ArrayOfDistrict (opcional)
Voltar ao topo

GetLanguages

Devolve as linguagens presentes no sistema, no esquema IETF language tag.

Parâmetros de resposta

GetLanguagesResult : ArrayOfLanguage (mandatório)
Voltar ao topo

GetLastPOIs

Devolve os últimos POIs registados.

Parâmetros do pedido

pageNumber : int (mandatório)
recordsPerPage : int (mandatório)

Parâmetros de resposta

GetLastPOIsResult : ArrayOfPOI (opcional)
Voltar ao topo

GetLastPOIsByCategoryId

Devolve os últimos POIs registados, dado um id duma categoria

Parâmetros do pedido

categoryId : int (mandatório)
pageNumber : int (mandatório)
recordsPerPage : int (mandatório)

Parâmetros de resposta

GetLastPOIsByCategoryIdResult : ArrayOfPOI (opcional)
Voltar ao topo

GetMatchLevels

Retorna uma lista dos níveis de "match" disponíveis (i.e. precisão da georreferenciação)

Parâmetros de resposta

GetMatchLevelsResult : ArrayOfMatchLevel (opcional)
Voltar ao topo

GetMunicipalitiesByDistrictIdSortedById

Devolve uma lista de municípios dado um distrito, ordenados por id

Parâmetros do pedido

districtId : string (mandatório)

Parâmetros de resposta

GetMunicipalitiesByDistrictIdSortedByIdResult : ArrayOfMunicipality (opcional)
Voltar ao topo

GetMunicipalitiesByDistrictIdSortedByName

Devolve uma lista de municípios dado um distrito, ordenados por nome

Parâmetros do pedido

districtId : string (mandatório)

Parâmetros de resposta

GetMunicipalitiesByDistrictIdSortedByNameResult : ArrayOfMunicipality (opcional)
Voltar ao topo

GetMunicipalitiesSortedById

Devolve uma lista de municípios ordenados por id

Parâmetros do pedido

includeParishes : boolean (mandatório)

Parâmetros de resposta

GetMunicipalitiesSortedByIdResult : ArrayOfMunicipality (opcional)
Voltar ao topo

GetMunicipalitiesSortedByName

Devolve uma lista de municípios ordenados por nome

Parâmetros do pedido

includeParishes : boolean (mandatório)

Parâmetros de resposta

GetMunicipalitiesSortedByNameResult : ArrayOfMunicipality (opcional)
Voltar ao topo

GetMunicipalityById

Devolve os dados de um município dado um id

Parâmetros do pedido

municipalityId : string (opcional)

Parâmetros de resposta

GetMunicipalityByIdResult : Municipality (opcional)
Voltar ao topo

GetNeighborDistricts

Devolve uma lista de distritos limítrofes

Parâmetros do pedido

districtId : string (mandatório)

Parâmetros de resposta

GetNeighborDistrictsResult : ArrayOfParish (opcional)
Voltar ao topo

GetNeighborMunicipalities

Devolve uma lista de concelhos limítrofes

Parâmetros do pedido

municipalityId : string (mandatório)

Parâmetros de resposta

GetNeighborMunicipalitiesResult : ArrayOfParish (opcional)
Voltar ao topo

GetNeighborParishes

Devolve uma lista de freguesias limítrofes

Parâmetros do pedido

parishId : string (mandatório)

Parâmetros de resposta

GetNeighborParishesResult : ArrayOfParish (opcional)
Voltar ao topo

GetParishById

Devolve os dados de uma freguesia dado um id

Parâmetros do pedido

parishId : string (opcional)

Parâmetros de resposta

GetParishByIdResult : Parish (opcional)
Voltar ao topo

GetParishesByMunicipalityIdSortedById

Devolve uma lista de freguesias dado um município, ordenadas por id

Parâmetros do pedido

municipalityId : string (mandatório)

Parâmetros de resposta

GetParishesByMunicipalityIdSortedByIdResult : ArrayOfParish (opcional)
Voltar ao topo

GetParishesByMunicipalityIdSortedByName

Devolve uma lista de freguesias dado um município, ordenadas por nome

Parâmetros do pedido

municipalityId : string (mandatório)

Parâmetros de resposta

GetParishesByMunicipalityIdSortedByNameResult : ArrayOfParish (opcional)
Voltar ao topo

GetParishesSortedById

Devolve uma lista de freguesias ordenadas por id

Parâmetros de resposta

GetParishesSortedByIdResult : ArrayOfParish (opcional)
Voltar ao topo

GetParishesSortedByName

Devolve uma lista de freguesias ordenadas por name

Parâmetros de resposta

GetParishesSortedByNameResult : ArrayOfParish (opcional)
Voltar ao topo

GetPOIByBoundingBox

Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dadas as coordenadas dos cantos, inferior esquerdo e superior direito, de um rectangulo e, opcionalmente, uma categoria.

Parâmetros do pedido

latitude1 : double (mandatório)
longitude1 : double (mandatório)
latitude2 : double (mandatório)
longitude2 : double (mandatório)
categoryId : string (opcional)
matchlevelId : int (opcional)
trustlevelId : int (opcional)
pageNumber : int (opcional)
recordsPerPage : int (opcional)
startPublicationDate : dateTime (opcional)
endPublicationDate : dateTime (opcional)

Parâmetros de resposta

GetPOIByBoundingBoxResult : ArrayOfPOI (opcional)
Voltar ao topo

GetPOIByBoundingBoxAndCategoryIdAndText

Retorna uma lista de POIs dado uma àrea, o id de uma categoria e uma descrição textual. Opcionalmente o resultado pode ser filtrado pelo nivel de confiança e/ou pelo nivel de georeferenciação, se os seus valores forem especificados.

Parâmetros do pedido

latitude1 : float (mandatório)
latitude2 : float (mandatório)
longitude1 : float (mandatório)
longitude2 : float (mandatório)
categoryId : string (mandatório)
text : string (mandatório)
matchlevelId : int (opcional)
trustlevelId : int (opcional)
pageNumber : int (opcional)
recordsPerPage : int (opcional)

Parâmetros de resposta

GetPOIByBoundingBoxAndCategoryIdAndTextResult : ArrayOfPOI (opcional)
Voltar ao topo

GetPOIByCategoryIdAndSourceId

Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dados um distrito e uma categoria

Parâmetros do pedido

categoryId : string (mandatório)
sourceId : string (opcional)
matchlevelId : int (opcional)
trustlevelId : int (opcional)
pageNumber : int (opcional)
recordsPerPage : int (opcional)
startPublicationDate : dateTime (opcional)
endPublicationDate : dateTime (opcional)
districtId : string (opcional)

Parâmetros de resposta

GetPOIByCategoryIdAndSourceIdResult : ArrayOfPOI (opcional)
Voltar ao topo

GetPOIByCategoryIdAndText

Retorna uma lista de POIs dado o id de uma categoria e uma descrição textual. Opcionalmente o resultado pode ser filtrado pelo distrito e/ou pelo município, se os seus ids forem especificados.

Parâmetros do pedido

categoryId : string (mandatório)
districtId : string (opcional)
municipalityId : string (opcional)
parisId : string (opcional)
text : string (mandatório)
matchlevelId : int (opcional)
trustlevelId : int (opcional)
pageNumber : int (opcional)
recordsPerPage : int (opcional)
startPublicationDate : dateTime (opcional)
endPublicationDate : dateTime (opcional)
tags : string (opcional)
Campo para filtro por tags, separadas por virgula.

Parâmetros de resposta

GetPOIByCategoryIdAndTextResult : ArrayOfPOI (opcional)
Voltar ao topo

GetPOIByCoordinates

Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dadas as coordenadas

Parâmetros do pedido

latitude : float (opcional)
longitude : float (opcional)
radius : float (opcional)
matchlevelId : int (opcional)
trustlevelId : int (opcional)
pageNumber : int (opcional)
recordsPerPage : int (opcional)

Parâmetros de resposta

GetPOIByCoordinatesResult : ArrayOfPOI (opcional)
Voltar ao topo

GetPOIByCoordinatesAndCategories

Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dadas as coordenadas e um conjunto de categorias

Parâmetros do pedido

latitude : float (mandatório)
longitude : float (mandatório)
radius : float (mandatório)
categories : string (mandatório)
matchlevelId : int (opcional)
trustlevelId : int (opcional)
pageNumber : int (opcional)
recordsPerPage : int (opcional)

Parâmetros de resposta

GetPOIByCoordinatesAndCategoriesResult : ArrayOfPOI (opcional)
Voltar ao topo

GetPOIByCoordinatesAndCategoryId

Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dadas as coordenadas e uma categoria

Parâmetros do pedido

latitude : float (opcional)
longitude : float (opcional)
radius : float (opcional)
categoryId : int (opcional)
matchlevelId : int (opcional)
trustlevelId : int (opcional)
pageNumber : int (opcional)
recordsPerPage : int (opcional)
sourceId : string (opcional)

Parâmetros de resposta

GetPOIByCoordinatesAndCategoryIdResult : ArrayOfPOI (opcional)
Voltar ao topo

GetPOIByCoordinatesAndText

Retorna uma lista de POIs, dados um par de coordenadas e uma descrição textual

Parâmetros do pedido

latitude : float (mandatório)
longitude : float (mandatório)
radius : float (mandatório)
text : string (mandatório)
matchlevelId : int (opcional)
trustlevelId : int (opcional)
pageNumber : int (opcional)
recordsPerPage : int (opcional)

Parâmetros de resposta

GetPOIByCoordinatesAndTextResult : ArrayOfPOI (opcional)
Voltar ao topo

GetPOIByDistrictId

Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dado um distrito

Parâmetros do pedido

districtId : string (opcional)
matchlevelId : int (opcional)
trustlevelId : int (opcional)
pageNumber : int (opcional)
recordsPerPage : int (opcional)
startPublicationDate : dateTime (opcional)
endPublicationDate : dateTime (opcional)

Parâmetros de resposta

GetPOIByDistrictIdResult : ArrayOfPOI (opcional)
Voltar ao topo

GetPOIByDistrictIdAndCategoryId

Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dados um distrito e uma categoria

Parâmetros do pedido

districtId : string (mandatório)
categoryId : string (mandatório)
text : string (opcional)
matchlevelId : int (opcional)
trustlevelId : int (opcional)
pageNumber : int (opcional)
recordsPerPage : int (opcional)
startPublicationDate : dateTime (opcional)
endPublicationDate : dateTime (opcional)
sourceId : string (opcional)

Parâmetros de resposta

GetPOIByDistrictIdAndCategoryIdResult : ArrayOfPOI (opcional)
Voltar ao topo

GetPOIByDistrictIdAndText

Devolve uma lista de POIs de um dado distrito, filtrados pelo texto especificado

Parâmetros do pedido

districtId : string (mandatório)
text : string (mandatório)
matchlevelId : int (opcional)
trustlevelId : int (opcional)
pageNumber : int (opcional)
recordsPerPage : int (opcional)
startPublicationDate : dateTime (opcional)
endPublicationDate : dateTime (opcional)

Parâmetros de resposta

GetPOIByDistrictIdAndTextResult : ArrayOfPOI (opcional)
Voltar ao topo

GetPOIById

Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dado um id

Parâmetros do pedido

poiId : string (opcional)

Parâmetros de resposta

GetPOIByIdResult : POI (opcional)
Voltar ao topo

GetPOIByMunicipalityId

Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dado um município

Parâmetros do pedido

municipalityId : string (opcional)
matchlevelId : int (opcional)
trustlevelId : int (opcional)
pageNumber : int (opcional)
recordsPerPage : int (opcional)
startPublicationDate : dateTime (opcional)
endPublicationDate : dateTime (opcional)

Parâmetros de resposta

GetPOIByMunicipalityIdResult : ArrayOfPOI (opcional)
Voltar ao topo

GetPOIByMunicipalityIdAndCategoryId

Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dados um município e uma categoria

Parâmetros do pedido

municipalityId : string (opcional)
categoryId : int (opcional)
matchlevelId : int (opcional)
trustlevelId : int (opcional)
pageNumber : int (opcional)
recordsPerPage : int (opcional)
startPublicationDate : dateTime (opcional)
endPublicationDate : dateTime (opcional)
sourceId : string (opcional)

Parâmetros de resposta

GetPOIByMunicipalityIdAndCategoryIdResult : ArrayOfPOI (opcional)
Voltar ao topo

GetPOIByMunicipalityIdAndText

Devolve uma lista de POIs de um dado concelho, filtrados pelo texto especificado

Parâmetros do pedido

municipalityId : string (mandatório)
text : string (mandatório)
matchlevelId : int (opcional)
trustlevelId : int (opcional)
pageNumber : int (opcional)
recordsPerPage : int (opcional)
startPublicationDate : dateTime (opcional)
endPublicationDate : dateTime (opcional)

Parâmetros de resposta

GetPOIByMunicipalityIdAndTextResult : ArrayOfPOI (opcional)
Voltar ao topo

GetPOIByParishId

Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dada uma freguesia

Parâmetros do pedido

parishId : string (opcional)
matchlevelId : int (opcional)
trustlevelId : int (opcional)
pageNumber : int (opcional)
recordsPerPage : int (opcional)
startPublicationDate : dateTime (opcional)
endPublicationDate : dateTime (opcional)

Parâmetros de resposta

GetPOIByParishIdResult : ArrayOfPOI (opcional)
Voltar ao topo

GetPOIByParishIdAndCategoryId

Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dadas uma freguesia e uma categoria

Parâmetros do pedido

parishId : string (opcional)
categoryId : int (opcional)
matchlevelId : int (opcional)
trustlevelId : int (opcional)
pageNumber : int (opcional)
recordsPerPage : int (opcional)
startPublicationDate : dateTime (opcional)
endPublicationDate : dateTime (opcional)

Parâmetros de resposta

GetPOIByParishIdAndCategoryIdResult : ArrayOfPOI (opcional)
Voltar ao topo

GetPOIByParishIdAndText

Devolve uma lista de POIs de uma dada freguesia, filtrados pelo texto especificado

Parâmetros do pedido

parishId : string (mandatório)
text : string (mandatório)
matchlevelId : int (opcional)
trustlevelId : int (opcional)
pageNumber : int (opcional)
recordsPerPage : int (opcional)
startPublicationDate : dateTime (opcional)
endPublicationDate : dateTime (opcional)

Parâmetros de resposta

GetPOIByParishIdAndTextResult : ArrayOfPOI (opcional)
Voltar ao topo

GetPOIByPOISourceId

Devolve um POI, dados o categoryId, sourceId e poiSourceId.

Parâmetros do pedido

categoryId : int (mandatório)
sourceId : int (mandatório)
poiSourceId : string (mandatório)

Parâmetros de resposta

GetPOIByPOISourceIdResult : POI (mandatório)
Voltar ao topo

GetPOIByTags

Devolve uma lista de POIs, dada uma lista de tags.

Parâmetros do pedido

tags : string (mandatório)
matchlevelId : int (opcional)
trustlevelId : int (opcional)
pageNumber : int (opcional)
recordsPerPage : int (opcional)
startPublicationDate : dateTime (opcional)
endPublicationDate : dateTime (opcional)

Parâmetros de resposta

GetPOIByTagsResult : ArrayOfPOI (opcional)
Voltar ao topo

GetPOIByText

Devolve pontos de interesse (locais, monumentos, bancos, hospitais, correios, etc.) dada uma expressão

Parâmetros do pedido

text : string (opcional)
pageNumber : int (opcional)
recordsPerPage : int (opcional)
startPublicationDate : dateTime (opcional)
endPublicationDate : dateTime (opcional)

Parâmetros de resposta

GetPOIByTextResult : ArrayOfPOI (opcional)
Voltar ao topo

GetTrustLevels

Devolve uma lista com os níveis de confiança disponíveis. Estes níveis indicam o nível de qualidade da georreferenciação.

Parâmetros de resposta

GetTrustLevelsResult : ArrayOfTrustLevel (opcional)
Voltar ao topo

Cinema Entidades

ArrayOfContribution

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

ArrayOfContributor

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

ArrayOfContributorRole

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

ArrayOfCountry

Voltar ao topo

ArrayOfExternalId

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

ArrayOfGenre

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

ArrayOfGenreId

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

ArrayOfLink

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

ArrayOfLocationId

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

ArrayOfMediaItem

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

ArrayOfMovie

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

ArrayOfMovieShowTimes

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

ArrayOfPerson

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

ArrayOfProductionCountryId

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

ArrayOfQuote

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

ArrayOfRating

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

ArrayOfRatingId

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

ArrayOfShowTime

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

ArrayOfTheater

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

ArrayOfTheaterShowTimes

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

ArrayOfThumbnail

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

ArrayOfVersions

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

Authority

Nome do atributo Descrição
Id : string
Name : string
Country : Country (opcional)
Ratings : ArrayOfRating (opcional)
Voltar ao topo

Contact

Nome do atributo Descrição
URL : string (opcional)
Email : string (opcional)
Phone : string (opcional)
CellPhone : string (opcional)
Voltar ao topo

Contribution

Nome do atributo Descrição
Movie : Movie
Role : ContributorRole
Voltar ao topo

Contributor

Nome do atributo Descrição
SourceId : string
Source : string
Voltar ao topo

ContributorRole

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

Country

Voltar ao topo

ExternalId

Nome do atributo Descrição
Source : ExternalIdSource
Id : string
Voltar ao topo

ExternalIdSource

Valor Descrição
Meo
Sercultur
IMDB
Voltar ao topo

Genre

Nome do atributo Descrição
Id : string
Name : string
Slug : string (opcional)
WorkCount : int (opcional)
Voltar ao topo

Link

Voltar ao topo

ListOfContributorRoles

Nome do atributo Descrição
ContributorRoles : ArrayOfContributorRole
PaginationDetails : PaginationDetails
Voltar ao topo

ListOfGenres

Nome do atributo Descrição
Genres : ArrayOfGenre
PaginationDetails : PaginationDetails
Voltar ao topo

ListOfMovies

Nome do atributo Descrição
Movies : ArrayOfMovie
PaginationDetails : PaginationDetails
Voltar ao topo

ListOfPerson

Nome do atributo Descrição
Persons : ArrayOfPerson
PaginationDetails : PaginationDetails
Voltar ao topo

ListOfTheaters

Nome do atributo Descrição
Theaters : ArrayOfTheater
PaginationDetails : PaginationDetails
Voltar ao topo

Location

Nome do atributo Descrição
CountryId : string (opcional)
CountryName : string (opcional)
DistrictId : string (opcional)
DistrictName : string (opcional)
MunicipalityId : string (opcional)
MunicipalityName : string (opcional)
ParishId : string (opcional)
ParishName : string (opcional)
Latitude : float (opcional)
Longitude : float (opcional)
Metadata : LocationMetadata (opcional)
ZipCode : string (opcional)
Locality : string (opcional)
Street : string (opcional)
HouseNumber : string (opcional)
MatchLevel : string (opcional)
Voltar ao topo

LocationMetadata

Nome do atributo Descrição
Provider : string
TrustLevel : string (opcional)
ISP : string (opcional)
Voltar ao topo

MediaCategory

Valor Descrição
Poster
Trailer
Image
Video
Voltar ao topo

MediaItem

RandName é o identificador único de um vídeo na plataforma SAPO Videos. Para mais informação, consultar: http://services.sapo.pt/Metadata/Service/Videos
Nome do atributo Descrição
Type : MediaType
Category : MediaCategory
Name : string (opcional)
URL : string (opcional)
RandName : string (opcional)
Extension : string (opcional)
Width : float (opcional)
Height : float (opcional)
Thumbnails : ArrayOfThumbnail (opcional)
Voltar ao topo

MediaType

Valor Descrição
Image
Video
Voltar ao topo

Movie

Nome do atributo Descrição
Id : string
Url : string (opcional)
Title : string (opcional)
Release : Release (opcional)
Year : int (opcional)
ProductionCountries : ArrayOfCountry (opcional)
Runtime : int (opcional)
Synopsis : string (opcional)
Contributors : ArrayOfContributor (opcional)
Genres : ArrayOfGenre (opcional)
Media : ArrayOfMediaItem (opcional)
References : References (opcional)
TheaterShowTimesList : ArrayOfTheaterShowTimes (opcional)
CreateDate : dateTime
UpdateDate : dateTime (opcional)
Quotes : ArrayOfQuote (opcional)
Version : int (opcional)
VersionAbbr : string (opcional)
Versions : ArrayOfVersions (opcional)
Rating : int (opcional)
Voltar ao topo

MovieShowTimes

Nome do atributo Descrição
Movie : Movie
ShowTimes : ArrayOfShowTime
TheaterTicketOfficeURL : string (opcional)
Voltar ao topo

PaginationDetails

Nome do atributo Descrição
CurrentPage : integer
RecordsPerPage : integer
RecordsTotal : integer
Voltar ao topo

Person

Nome do atributo Descrição
Id : string
Url : string (opcional)
Name : string
BornDate : date (opcional)
DiedDate : date (opcional)
Country : Country (opcional)
Biography : string (opcional)
Media : ArrayOfMediaItem (opcional)
Contributions : ArrayOfContribution (opcional)
CreateDate : dateTime (opcional)
UpdateDate : dateTime (opcional)
Voltar ao topo

Quote

Nome do atributo Descrição
Title : string
CharacterName : string
Movie : Movie (opcional)
Voltar ao topo

Rating

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

References

Nome do atributo Descrição
ExternalIds : ArrayOfExternalId (opcional)
Links : ArrayOfLink (opcional)
Voltar ao topo

Release

Nome do atributo Descrição
Country : Country
Title : string (opcional)
Distributor : string (opcional)
ReleaseDate : dateTime (opcional)
Rating : Rating (opcional)
Authority : Authority (opcional)
Voltar ao topo

ShowTime

Nome do atributo Descrição
TimeStart : dateTime
ShowTimeTicketOfficeURL : string (opcional)
Voltar ao topo

Theater

Nome do atributo Descrição
Id : string
Name : string
Contact : Contact (opcional)
TicketOfficeURL : string (opcional)
Location : Location (opcional)
Description : string (opcional)
MovieShowTimesList : ArrayOfMovieShowTimes (opcional)
CreateDate : dateTime
UpdateDate : dateTime (opcional)
MoviesTotal : int (opcional)
Voltar ao topo

TheaterShowTimes

Nome do atributo Descrição
Theater : Theater
ShowTimes : ArrayOfShowTime
TheaterTicketOfficeURL : string (opcional)
Voltar ao topo

Thumbnail

Nome do atributo Descrição
Name : string (opcional)
URL : string
Width : float
Height : float
Voltar ao topo

Version

Nome do atributo Descrição
Id : int
Abbr : string
IsMain : boolean
Voltar ao topo

GIS Entidades

ArrayOfCategory

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

ArrayOfCountry

Voltar ao topo

ArrayOfDistrict

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

ArrayOfLanguage

Voltar ao topo

ArrayOfMatchLevel

Voltar ao topo

ArrayOfMunicipality

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

ArrayOfParish

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

ArrayOfPOI

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

ArrayOfTrustLevel

Voltar ao topo

Category

Nome do atributo Descrição
CategoryId : int (opcional)
CategoryName : string (opcional)
Description : string (opcional)
Tags : string (opcional)
Voltar ao topo

Contributor

Nome do atributo Descrição
SourceId : string
Source : string
Voltar ao topo

Contributors

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

Details

Nome do atributo Descrição
User : User (opcional)
Icon : string (opcional)
Pictures : Pictures (opcional)
Movies : Movies (opcional)
Contributors : Contributors (opcional)
Voltar ao topo

DetailXml

Nome do atributo Descrição
Details : Details
Voltar ao topo

District

Nome do atributo Descrição
DistrictId : string (opcional)
DistrictName : string (opcional)
Latitude : float (opcional)
Longitude : float (opcional)
Municipalities : ArrayOfMunicipality (opcional)
Voltar ao topo

Media

Voltar ao topo

Movies

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

Municipality

Nome do atributo Descrição
MunicipalityId : string (opcional)
MunicipalityName : string (opcional)
Latitude : float (opcional)
Longitude : float (opcional)
UrlForm : string (opcional)
Parishes : ArrayOfParish (opcional)
Voltar ao topo

Parish

Nome do atributo Descrição
ParishId : string (opcional)
ParishName : string (opcional)
Latitude : float (opcional)
Longitude : float (opcional)
Voltar ao topo

Pictures

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

POI

Nome do atributo Descrição
POIId : string (opcional)
Name : string (opcional)
CountryId : string (opcional)
Country : string (opcional)
DistrictId : string (opcional)
District : string (opcional)
MunicipalityId : string (opcional)
Municipality : string (opcional)
ParishId : string (opcional)
Parish : string (opcional)
Address : string (opcional)
ZipCode : string (opcional)
Phone : string (opcional)
Fax : string (opcional)
LocalityId : int (opcional)
Locality : string (opcional)
StreetId : int (opcional)
Street : string (opcional)
HouseNumber : string (opcional)
Latitude : float (opcional)
Longitude : float (opcional)
Distance : float (opcional)
CategoryId : string (opcional)
Category : string (opcional)
MimeType : string (opcional)
SourceId : int (opcional)
Source : string (opcional)
POISourceId : string (opcional)
URL : string (opcional)
EMail : string (opcional)
PublicationDate : string (opcional)
RegistrationDate : string (opcional)
ExpirationDate : string (opcional)
Description : string (opcional)
Detail : string (opcional)
Tags : string (opcional)
MatchLevelId : int (opcional)
MatchLevel : string (opcional)
TrustLevelId : int (opcional)
TrustLevel : string (opcional)
LastModified : string (opcional)
Revision : string (opcional)
DetailXml : DetailXml (opcional)
UserToken : string (opcional)
Voltar ao topo

User

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

Valores para o Parâmetro Área

Área

Nome Valor
Abrantes 1401
Águeda 0101
Aguiar da Beira 0901
Alandroal 0701
Albergaria-a-Velha 0102
Albufeira 0801
Alcácer do Sal 1501
Alcanena 1402
Alcobaça 1001
Alcochete 1502
Alcoutim 0802
Alenquer 1101
Alfândega da Fé 0401
Alijó 1701
Aljezur 0803
Aljustrel 0201
Almada 1503
Almeida 0902
Almeirim 1403
Almodôvar 0202
Alpiarça 1404
Alter do Chão 1201
Alvaiázere 1002
Alvito 0203
Amadora 1115
Amarante 1301
Amares 0301
Anadia 0103
Angra do Heroísmo 4301
Ansião 1003
Arcos de Valdevez 1601
Arganil 0601
Armamar 1801
Arouca 0104
Arraiolos 0702
Arronches 1202
Arruda dos Vinhos 1102
Aveiro 0105
Avis 1203
Azambuja 1103
Baião 1302
Barcelos 0302
Barrancos 0204
Barreiro 1504
Batalha 1004
Beja 0205
Belmonte 0501
Benavente 1405
Bombarral 1005
Borba 0703
Boticas 1702
Braga 0303
Bragança 0402
Cabeceiras de Basto 0304
Cadaval 1104
Caldas da Rainha 1006
Calheta 3101
Calheta de São Jorge 4501
Câmara de Lobos 3102
Caminha 1602
Campo Maior 1204
Cantanhede 0602
Carrazeda de Ansiães 0403
Carregal do Sal 1802
Cartaxo 1406
Cascais 1105
Castanheira de Pêra 1007
Castelo Branco 0502
Castelo de Paiva 0106
Castelo de Vide 1205
Castro Daire 1803
Castro Marim 0804
Castro Verde 0206
Celorico da Beira 0903
Celorico de Basto 0305
Chamusca 1407
Chaves 1703
Cinfães 1804
Coimbra 0603
Condeixa-a-Nova 0604
Constância 1408
Coruche 1409
Corvo 4901
Covilhã 0503
Crato 1206
Cuba 0207
Elvas 1207
Entroncamento 1410
Espinho 0107
Esposende 0306
Estarreja 0108
Estremoz 0704
Évora 0705
Fafe 0307
Faro 0805
Felgueiras 1303
Ferreira do Alentejo 0208
Ferreira do Zêzere 1411
Figueira da Foz 0605
Figueira de Castelo Rodrigo 0904
Figueiró dos Vinhos 1008
Fornos de Algodres 0905
Freixo de Espada à Cinta 0404
Fronteira 1208
Funchal 3103
Fundão 0504
Gavião 1209
Góis 0606
Golegã 1412
Gondomar 1304
Gouveia 0906
Grândola 1505
Guarda 0907
Guimarães 0308
Horta 4701
Idanha-a-Nova 0505
Ílhavo 0110
Lagoa 0806
Lagoa 4201
Lagos 0807
Lajes das Flores 4801
Lajes do Pico 4601
Lamego 1805
Leiria 1009
Lisboa 1106
Loulé 0808
Loures 1107
Lourinhã 1108
Lousã 0607
Lousada 1305
Mação 1413
Macedo de Cavaleiros 0405
Machico 3104
Madalena 4602
Mafra 1109
Maia 1306
Mangualde 1806
Manteigas 0908
Marco de Canaveses 1307
Marinha Grande 1010
Marvão 1210
Matosinhos 1308
Mealhada 0111
Mêda 0909
Melgaço 1603
Mértola 0209
Mesão Frio 1704
Mira 0608
Miranda do Corvo 0609
Miranda do Douro 0406
Mirandela 0407
Mogadouro 0408
Moimenta da Beira 1807
Moita 1506
Monção 1604
Monchique 0809
Mondim de Basto 1705
Monforte 1211
Montalegre 1706
Montemor-o-Novo 0706
Montemor-o-Velho 0610
Montijo 1507
Mora 0707
Mortágua 1808
Moura 0210
Mourão 0708
Murça 1707
Murtosa 0112
Nazaré 1011
Nelas 1809
Nisa 1212
Nordeste 4202
Óbidos 1012
Odemira 0211
Odivelas 1116
Oeiras 1110
Oleiros 0506
Olhão 0810
Oliveira de Azeméis 0113
Oliveira de Frades 1810
Oliveira do Bairro 0114
Oliveira do Hospital 0611
Ourém 1421
Ourique 0212
Ovar 0115
Paços de Ferreira 1309
Palmela 1508
Pampilhosa da Serra 0612
Paredes 1310
Paredes de Coura 1605
Pedrógão Grande 1013
Penacova 0613
Penafiel 1311
Penalva do Castelo 1811
Penamacor 0507
Penedono 1812
Penela 0614
Peniche 1014
Peso da Régua 1708
Pinhel 0910
Pombal 1015
Ponta Delgada 4203
Ponta do Sol 3105
Ponte da Barca 1606
Ponte de Lima 1607
Ponte de Sor 1213
Portalegre 1214
Portel 0709
Portimão 0811
Porto 1312
Porto de Mós 1016
Porto Moniz 3106
Porto Santo 3201
Póvoa de Lanhoso 0309
Póvoa de Varzim 1313
Povoação 4204
Praia da Vitória 4302
Proença-a-Nova 0508
Redondo 0710
Reguengos de Monsaraz 0711
Resende 1813
Ribeira Brava 3107
Ribeira de Pena 1709
Ribeira Grande 4205
Rio Maior 1414
Sabrosa 1710
Sabugal 0911
Salvaterra de Magos 1415
Santa Comba Dão 1814
Santa Cruz 3108
Santa Cruz da Graciosa 4401
Santa Cruz das Flores 4802
Santa Maria da Feira 0109
Santa Marta de Penaguião 1711
Santana 3109
Santarém 1416
Santiago do Cacém 1509
Santo Tirso 1314
São Brás de Alportel 0812
São João da Madeira 0116
São João da Pesqueira 1815
São Pedro do Sul 1816
São Roque do Pico 4603
São Vicente 3110
Sardoal 1417
Sátão 1817
Seia 0912
Seixal 1510
Sernancelhe 1818
Serpa 0213
Sertã 0509
Sesimbra 1511
Setúbal 1512
Sever do Vouga 0117
Silves 0813
Sines 1513
Sintra 1111
Sobral de Monte Agraço 1112
Soure 0615
Sousel 1215
Tábua 0616
Tabuaço 1819
Tarouca 1820
Tavira 0814
Terras de Bouro 0310
Tomar 1418
Tondela 1821
Torre de Moncorvo 0409
Torres Novas 1419
Torres Vedras 1113
Trancoso 0913
Trofa 1318
Vagos 0118
Vale de Cambra 0119
Valença 1608
Valongo 1315
Valpaços 1712
Velas 4502
Vendas Novas 0712
Viana do Alentejo 0713
Viana do Castelo 1609
Vidigueira 0214
Vieira do Minho 0311
Vila de Rei 0510
Vila do Bispo 0815
Vila do Conde 1316
Vila do Porto 4101
Vila Flor 0410
Vila Franca de Xira 1114
Vila Franca do Campo 4206
Vila Nova da Barquinha 1420
Vila Nova de Cerveira 1610
Vila Nova de Famalicão 0312
Vila Nova de Foz Côa 0914
Vila Nova de Gaia 1317
Vila Nova de Paiva 1822
Vila Nova de Poiares 0617
Vila Pouca de Aguiar 1713
Vila Real 1714
Vila Real de Santo António 0816
Vila Velha de Ródão 0511
Vila Verde 0313
Vila Viçosa 0714
Vimioso 0411
Vinhais 0412
Viseu 1823
Vizela 0314
Vouzela 1824
Voltar ao topo