Alertas

Alertas

O serviço Sapo Alertas permite aos seus utilizadores a subscrição de eventos e consequente notificação da sua ocorrência através do meio desejado, como email, sms ou IM/XMPP.

Subscrição gratuita

Descrição Técnica

Serviço AlertsFramework

O serviço Sapo Alertas permite aos seus utilizadores a subscrição de eventos e consequente notificação da sua ocorrência através do meio desejado, como email, sms ou IM/XMPP.

Manual de Referência da API

Serviço Operação Descrição
AlertsFramework ActivateSubscription Define o estado da subscrição (Activo/Inactivo).
AddDestination Adiciona um novo tipo de canal de entrega associado a um utilizador
AddSubscription Adiciona uma subscrição associada a um utilizador
CreateUser Cria um novo utilizador
GetDeliveryChannelList Obtém uma lista com os canais de entrega disponíveis, tais como SMTP, SMS, XMPP
GetDestinationList Obtém a lista de canais de entrega de um utilizador
GetDestinationListBySubscription Obtém a lista de canais de entrega de um utilizador para determinada subscrição
GetEventDetail Obtém informaçao detalhada sobre um evento, como as propriedas passíveis de filtragem
GetEventList Obtém uma lista com todos os eventos disponíveis
GetLastNotifications Obtém a últimas notificações para um utilizador de qualquer tipo de evento.
GetSubscriptionList Obtém a lista de subscrições de um utilizador
GetSubscriptionListByEvent Obtém a lista de subscrições de determinado tipo evento de um utilizador
GetSubscriptionNotifications Obtém as últimas notificações para dada subscrição.
GetSubscriptionsWithNotification Obtém a lista de subscrições do utilizador e a última notificação para cada.
RemoveAllSubscriptions Remove todas as subscrições de um utilizador
RemoveDestination Remove um canal de entrega de um utilizador
RemoveSubscription Remove determinada subscrição de um utilizador
RemoveUser Remove um utilizador e tudo o que estiver relacionado com ele
SendValidationCode Envia o código de verificação para determinado destino.
ValidateDestination Valida o contacto de um utilizador

Serviço

Operações

ActivateSubscription

Define o estado da subscrição (Activo/Inactivo).
Parâmetros do pedido
ActivateSubscriptionInfo : ActivateSubscriptionInfo (mandatório)
Parâmetros de resposta
Status : string (opcional)
Voltar ao topo

AddDestination

Adiciona um novo tipo de canal de entrega associado a um utilizador
Parâmetros do pedido
UserDestination : UserDestination (mandatório)
Parâmetros de resposta
AddDestinationResult : string (mandatório)
Voltar ao topo

AddSubscription

Adiciona uma subscrição associada a um utilizador
Parâmetros do pedido
Subscription : Subscription (mandatório)
Parâmetros de resposta
AddSubscriptionResult : string (mandatório)
Voltar ao topo

CreateUser

Cria um novo utilizador
Parâmetros do pedido
CreateUserInfo : CreateUserInfo (mandatório)
Parâmetros de resposta
Status : string (opcional)
Voltar ao topo

GetDeliveryChannelList

Obtém uma lista com os canais de entrega disponíveis, tais como SMTP, SMS, XMPP
Parâmetros do pedido
AppId : string (mandatório)
Parâmetros de resposta
GetDeliveryChannelListResult : DeliveryChannelList (opcional)
Voltar ao topo

GetDestinationList

Obtém a lista de canais de entrega de um utilizador
Parâmetros do pedido
UserInfo : UserInfo (mandatório)
Parâmetros de resposta
GetDestinationListResult : DestinationList (mandatório)
Voltar ao topo

GetDestinationListBySubscription

Obtém a lista de canais de entrega de um utilizador para determinada subscrição
Parâmetros do pedido
GetDestinationListBySubscriptionInfo : GetDestinationListBySubscriptionInfo (mandatório)
Parâmetros de resposta
GetDestinationListBySubscriptionResult : DestinationList (mandatório)
Voltar ao topo

GetEventDetail

Obtém informaçao detalhada sobre um evento, como as propriedas passíveis de filtragem
Parâmetros do pedido
GetEventDetailInfo : GetEventDetailInfo (mandatório)
Parâmetros de resposta
GetEventDetailResult : EventDetail (mandatório)
Voltar ao topo

GetEventList

Obtém uma lista com todos os eventos disponíveis
Parâmetros do pedido
AppId : string (mandatório)
Parâmetros de resposta
GetEventListResult : EventList (mandatório)
Voltar ao topo

GetLastNotifications

Obtém a últimas notificações para um utilizador de qualquer tipo de evento.
Parâmetros do pedido
GetLastNotificationsInfo : GetLastNotificationsInfo (mandatório)
Parâmetros de resposta
GetLastNotificationsResult : NotificationList (opcional)
Voltar ao topo

GetSubscriptionList

Obtém a lista de subscrições de um utilizador
Parâmetros do pedido
UserInfo : UserInfo (mandatório)
Parâmetros de resposta
GetSubscriptionListResult : SubscriptionList (mandatório)
Voltar ao topo

GetSubscriptionListByEvent

Obtém a lista de subscrições de determinado tipo evento de um utilizador
Parâmetros do pedido
GetSubscriptionListByEventInfo : GetSubscriptionListByEventInfo (mandatório)
Parâmetros de resposta
GetSubscriptionListByEventResult : SubscriptionList (mandatório)
Voltar ao topo

GetSubscriptionNotifications

Obtém as últimas notificações para dada subscrição.
Parâmetros do pedido
GetSubscriptionNotificationsInfo : GetSubscriptionNotificationsInfo (mandatório)
Parâmetros de resposta
GetSubscriptionNotificationsResult : SubscriptionNotifications (mandatório)
Voltar ao topo

GetSubscriptionsWithNotification

Obtém a lista de subscrições do utilizador e a última notificação para cada.
Parâmetros do pedido
UserInfo : UserInfo (mandatório)
Parâmetros de resposta
GetSubscriptionsWithNotificationResult : SubscriptionWithNotificationList (mandatório)
Voltar ao topo

RemoveAllSubscriptions

Remove todas as subscrições de um utilizador
Parâmetros do pedido
UserInfo : UserInfo (mandatório)
Parâmetros de resposta
Status : string (opcional)
Voltar ao topo

RemoveDestination

Remove um canal de entrega de um utilizador
Parâmetros do pedido
RemoveDestinationInfo : RemoveDestinationInfo (mandatório)
Parâmetros de resposta
Status : string (opcional)
Voltar ao topo

RemoveSubscription

Remove determinada subscrição de um utilizador
Parâmetros do pedido
RemoveSubscriptionInfo : RemoveSubscriptionInfo (mandatório)
Parâmetros de resposta
Status : string (opcional)
Voltar ao topo

RemoveUser

Remove um utilizador e tudo o que estiver relacionado com ele
Parâmetros do pedido
UserInfo : UserInfo (mandatório)
Parâmetros de resposta
Status : string (opcional)
Voltar ao topo

SendValidationCode

Envia o código de verificação para determinado destino.
Parâmetros do pedido
SendValidationCodeInfo : SendValidationCodeInfo (mandatório)
Parâmetros de resposta
SendValidationCodeResult : string (mandatório)
Voltar ao topo

ValidateDestination

Valida o contacto de um utilizador
Parâmetros do pedido
ValidateDestinationInfo : ValidateDestinationInfo (mandatório)
Parâmetros de resposta
ValidateDestinationResult : string (mandatório)
Voltar ao topo

Entidades

ActivateSubscriptionInfo

Voltar ao topo

CreateUserInfo

Voltar ao topo

DeliveryChannelList

Voltar ao topo

DestinationList

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

EventDetail

Voltar ao topo

EventList

Voltar ao topo

GetDestinationListBySubscriptionInfo

Voltar ao topo

GetEventDetailInfo

Voltar ao topo

GetLastNotificationsInfo

Voltar ao topo

GetSubscriptionListByEventInfo

Voltar ao topo

GetSubscriptionNotificationsInfo

Voltar ao topo

Notification

Voltar ao topo

NotificationList

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

RemoveDestinationInfo

Voltar ao topo

RemoveSubscriptionInfo

Voltar ao topo

SendValidationCodeInfo

Voltar ao topo

Subscription

Voltar ao topo

SubscriptionList

Voltar ao topo

SubscriptionNotifications

Voltar ao topo

SubscriptionWithNotification

Voltar ao topo

SubscriptionWithNotificationList

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

UserDestination

Voltar ao topo

UserInfo

Voltar ao topo

ValidateDestinationInfo

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