STS

STS

Permite a obtenção de um TOKEN de autenticação para utilizadores SAPO (via email e password). Este TOKEN pode ser utilizado em serviços e/ou operações que requeiram algum nível de autorização específico.

Subscrição gratuita

Descrição Técnica

Serviço STS

Permite a obtenção de um TOKEN de autenticação para utilizadores SAPO (via email e password). Este TOKEN pode ser utilizado em serviços e/ou operações que requeiram algum nível de autorização específico.

Manual de Referência da API

Serviço Operação Descrição
STS GetPrimaryId Devolve informação do utilizador, o seu identificador primário e um token de segurança.
GetPrimaryIdDetails Devolve informação do utilizador, o seu identificador primário, um token de segurança e uma colecção de atributos
GetToken Devolve um token se um determinado username e senha forem válidos

Serviço STS

Operações

GetPrimaryId

Devolve informação do utilizador, o seu identificador primário e um token de segurança.
Parâmetros do pedido
ESBCredentials : ESBCredentials (opcional)
UserLogin : string (opcional)
JSON : boolean (opcional)
UserType : string (opcional)
UserLoginCredentialsStore : string (opcional)
Parâmetros de resposta
GetPrimaryIdResult : UserInfo (opcional)
Voltar ao topo

GetPrimaryIdDetails

Devolve informação do utilizador, o seu identificador primário, um token de segurança e uma colecção de atributos
Parâmetros do pedido
ESBCredentials : ESBCredentials (opcional)
UserLogin : string (opcional)
JSON : boolean (opcional)
UserType : string (opcional)
UserLoginCredentialsStore : string (opcional)
Parâmetros de resposta
GetPrimaryIdDetailsResult : UserInfo (opcional)
Voltar ao topo

GetToken

Devolve um token se um determinado username e senha forem válidos
Parâmetros do pedido
ESBCredentials : ESBCredentials (opcional)
JSON : boolean (opcional)
Parâmetros de resposta
GetTokenResult : string (opcional)
Voltar ao topo

STS Entidades

AccountNumbers

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

ArrayOfAttribute

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

Attribute

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

ESBCredentials

Voltar ao topo

ESBRoles

Voltar ao topo

UserInfo

Tipo agregador que contém a informação sobre o resposta de autenticação: identificador primário, token e informação adicional do utilizador
Nome do atributo Descrição
PrimaryId : string Identificador primário
ESBRoles : ESBRoles (opcional)
ESBToken : string
Group : string (opcional)
ESBCredentialsStore : string (opcional)
AccountNumbers : AccountNumbers (opcional)
Attributes : ArrayOfAttribute (opcional)
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