Serviço SemanticLists

SemanticLists é um serviço que fornece listas de palavras de determinadas categorias semânticas como profissões, tipos de organizações, nacionalidades entre outras. Os dados disponíveis neste serviço são apenas relativos à lingua portuguesa. Este serviço exporta os dados no formato JSON (por default).

Descarregar Contrato OSD do Serviço

Descarregar Guia de Iniciação Rápida

Serviço	Operação	Descrição
SemanticLists	GetListsFromWord	Retorna todas as listas (categoria e, se disponível, sub-categoria) que incluem a palavra dada (neste exemplo "engenheiro").
	GetListsInfo	Retorna (em formato JSON) o nome e uma breve descrição de todas as listas disponíveis. Se for passado o parâmetro opcional '?format=xml' o serviço retorna os dados em formato XML.
	GetWords	Retorna, para uma data lista definida pela "tag" (neste exemplo a categoria "eventos") e se disponível a "subtag" (neste exemplo a sub-categoria "desportivos"), todas as palavras e uma descrição (pares chave-valor como por exemplo "number:p") para cada palavra.

Serviço SemanticLists

GetListsFromWord

Retorna todas as listas (categoria e, se disponível, sub-categoria) que incluem a palavra dada (neste exemplo "engenheiro").

Voltar ao topo

GetListsInfo

Retorna (em formato JSON) o nome e uma breve descrição de todas as listas disponíveis. Se for passado o parâmetro opcional '?format=xml' o serviço retorna os dados em formato XML.

Voltar ao topo

GetWords

Retorna, para uma data lista definida pela "tag" (neste exemplo a categoria "eventos") e se disponível a "subtag" (neste exemplo a sub-categoria "desportivos"), todas as palavras e uma descrição (pares chave-valor como por exemplo "number:p") para cada palavra.

Voltar ao topo

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