Docs API Tranquilidade - Generali Seguros, S.A. - Digitização - Manual WebServices - V1 - 07

Generali Seguros
Digitização – 1.0
Manual WebServices
09/05/2023
Controlo do Documento
Responsável: Paulo Falcão
Histórico de Alterações
VERSÃO DATA AUTOR DESCRIÇÃO
0.90 11-02-2019 Paulo Falcão Versão draft
1.00 28-02-2019 Paulo Falcão Versão Inicial
1.01 01-04-2019 Paulo Falcão Pequenas alterações
1.02 12-04-2019 Paulo Falcão Alteração de descrições
1.03 22-05-2019 João Caseiro Alteração do Web Service WSDG009
1.04 17-12-2019 Paulo Falcão Alteração da descodificação do campo TipoRecebimentoDesc
1.05 27-11-2019 André Gomes Web Services WSDG010 e WSDG011 adicionados
1.06 07-03-2022 Tiago Silvestre Web Services WSDG012, WSDG013 e WSDG014 adicionados
Índice
Controlo do Documento .................................................................................................................................... 2
Histórico de Alterações ...................................................................................................................................... 2
Índice ................................................................................................................................................................ 3
1. Introdução .................................................................................................................................................. 4
2. Autenticação ............................................................................................................................................... 4
3. WebServices ............................................................................................................................................. 11
Modo de funcionamento dos serviços para obtenção de dados ................................................................ 11
3.1. WSDG001_ObterClientes .................................................................................................................. 12
3.2. WSDG002_ObterApolices ................................................................................................................. 16
3.3. WSDG003_ObterRecibos .................................................................................................................. 23
3.4. WSDG004_ObterSinistros ................................................................................................................. 27
3.5. WSDG005_CobrarRecibo .................................................................................................................. 32
3.6. WSDG006_ObterDocumentoRecibo ................................................................................................. 33
3.7. WSDG007_ObterDocumentoCartaVerde ......................................................................................... 34
3.8. WSDG008_CarregamentoInicial........................................................................................................ 35
3.9. WSDG009_ObterExtrato ................................................................................................................... 36
3.10. WSDG010_ObterExtratoRecibosNaoCobradosTecnicamente ...................................................... 37
3.11. WSDG011_ObterExtratoResolucaoContratos ............................................................................... 38
3.12. WSDG012_PesquisarRemessas ..................................................................................................... 39
3.13. WSDG013_ConsultarRemessa ....................................................................................................... 41
3.14. WSDG014_ObterFicheiroRemessa ................................................................................................ 43
4. Formato dos Dados................................................................................................................................... 44
5. Ambientes ................................................................................................................................................. 44
6. Limites de execução ................................................................................................................................. 45
7. Questões Técnicas .................................................................................................................................... 45
1. Introdução
Este documento descreve a API por WebServices que a Seguradoras Unidas disponibiliza a entidades
externas que são responsáveis pelo desenvolvimento dos sistemas informáticos utilizados pelos parceiros.
Tem assim como objetivo integrar informação entre os sistemas da Companhia com os sistemas dos
parceiros.
A solução consiste em criar uma API (um conjunto de WebServices e um sistema de Autenticação) de
forma que outras entidades (Agentes e Corretores) possam consultar o sistema da Tranquilidade de forma
integrada nas aplicações que já utilizam atualmente.
Siglas e Acrónimos
Sigla / acrónimo Significado Descrição

WSDL Web Services Description Language Ficheiro com a especificação dos serviços.
API Application Programming Interface Interface de Programação de Aplicações
OAuth Open standard for authorization Forma de autenticação especificada em
framework https://tools.ietf.org/html/rfc6749
XML eXtensible Markup Language Formato de dados, organizados de forma
hierárquica.
su_webserver WebServer das Seguradoras Unidas Ao longo do documento su_webserver é um
alias para o servidor das seguradoras unidas.
2. Autenticação
A API de Digitizacão disponibilizada pela Seguradoras Unidas é suportada por WebServices sobre HTTPS e
necessita de autenticação utilizando o sistema de autorização OAuth 2.0.
Usando sistema OAuth 2.0 é obtido um token de acesso (access_token) que depois é utilizado nas
chamadas aos WebServices, especificados por um WSDL.
O token obtido pode ser utilizado tal como indicado no protócolo OAuth 2.0, ou seja, usando o header
Authorization do tipo Bearer, ou então num campo aplicacional com o nome access_token.
O token obtido deve ser utilizado num campo aplicacional dos serviços com o nome access_token.
Não é possível usar o token no header Authorization.
Na nossa implementação do OAuth 2.0 os papeis "Resource Owner", "Resource Server" e "Authorization
Server" serão o sistema informático da Seguradoras Unidas.
Para a autenticação dos utilizadores da aplicação deve ser utilizado o fluxo de autenticação "Authorization
Code" (https://tools.ietf.org/html/rfc6749#section-1.3.1) , em que os utilizadores recebem um ecrã de
Autenticação das Seguradoras Unidas. A sessão obtida desta forma pode ser renovada usando o "Refresh
Token" ( https://tools.ietf.org/html/rfc6749#section-1.5 ) que foi obtido.
Os processos Batch podem utilizar um utilizador fixo aplicacional, utilizando “Password Grant” (
https://tools.ietf.org/html/rfc6749#section-4.3.2 ) em que podem passar o user e password aplicacional e
receber logo o access_token sem qualquer tipo de interatividade. Este tipo de autenticação apenas
funciona para utilizadores aplicacionais, não pode ser utilizado em utilizadores normais por questões de
segurança.
Em alternativa os processos batch podem também guardar as credenciais dos utilizadores guardando o
"Refresh Token" para executar processos Batch em nome dos utilizadores.
Para mais informação sobre OAuth 2.0 ver o rfc6749 - The OAuth 2.0 Authorization Framework
(https://tools.ietf.org/html/rfc6749)
Registo da Aplicação
Para utilizar esta API será necessário registar a sua aplicação, se está a ler este documento é porque
provavelmente este passo já foi dado.
ID do Cliente e Segredo do Cliente

Como resposta ao pedido de acesso à API foi-lhe entregue um ID do Cliente e um Segredo do Cliente
(cliente_id e client_secret)
O client_id será usado publicamente para identificar aplicação, o client_secret será utilizado para
autenticar a entidade que está a efetuar a autenticação.
O cliente_id e client_secret serão diferentes nos diferentes ambiente (ver secção 3.10 – Ambientes )
Fluxo de autenticação "Authorization Code".
1º Passo - Authorize
Esta forma de autenticação deve ser utilizada pelos utilizadores / agentes.
A aplicação deverá abrir num browser integrado com a aplicação, ou num browser à parte, onde é
efetuado um pedido HTTP GET ao URL https://su_webserver/invoke/Digitizacao.V1.OAuth/authorize com
os seguintes parâmetros:
Path - /invoke/Digitizacao.V1.OAuth/authorize
• client_id
o ID do Cliente da Aplicação.
• response_type
o code
▪ Indica o tipo de pedido / resposta
• scope
o read write
▪ Indica qual o nível de acesso que a aplicação esta a solicitar. Os vários parâmetros
devem ir separados com espaço, na nossa implementação é possível read e write, ou
seja read será o acesso a todos os WebServices de leitura e Write o acesso a todos os
WebServices de escrita.
• redirect_uri
o URL de Callback, como resposta do pedido a página retorna o código HTTP 302 de
redireccionamento para o Callback indicado adicionado no caso de sucesso o parâmetro
code.
▪ Exemplo: http://www.seguros2790.com/oauthcallback
o Para aplicações nativas sem servidor verificar https://www.oauth.com/oauth2-

servers/redirect-uris/redirect-uris-native-apps/
▪ Exemplo: myapp://callback
• state
o O parâmetro state é opcional, e é devolvido na resposta, pode ser útil ao cliente para
manter estado, e também é útil por questões de segurança.
Exemplo de um pedido:
https://su_webserver/invoke/Digitizacao.V1.OAuth/authorize?client_id=seguros2790&response_type=cod
e&scope=read%20write&redirect_uri=myapp%3A%2F%2Fcallback&state=hwwheyc52doy
O pedido será aberto num Browser ao utilizador, onde será pedido o user e password, como resposta
recebe um redireccionamento HTTP para o redirect_uri com o resultado da autenticação.
Se a autenticação correu bem será devolvido um parametro code no redireccionamento assim como o
parâmetro state, se este for enviado pelo cliente.
Mockup apenas para efeitos de ilustração

Não representa o aspeto do ecrã de
autenticação que será apresentado.
Resposta:
HTTP/1.1 302 Found

Location: myapp://callback?code=123456789&state=hwwhec52doy
Em caso de erro serão devolvidos os parâmetros error e error_description ver

(https://tools.ietf.org/html/rfc6749#section-4.1.2.1)
2º Passo - Token
No segundo passo, será pedido um access_token utilizando o code previamente obtido.
A aplicação efetua um pedido HTTP GET ou POST com os seguintes parâmetros:
Path - /invoke/Digitizacao.V1.OAuth/token
• client_id
• client_secret
o ID secreto da aplicação
• grant_type
o authorization_code
▪ Indica o tipo de fluxo de autenticação que estamos a utilizar.
• code
o O code que foi recebido no 1º passo.
• redirect_uri
o Por questões de segurança é colocado o mesmo redirect_uri que foi colocado no primeiro
pedido.
Exemplo de um pedido:
https://su_webserver/invoke/Digitizacao.V1.OAuth/token?client_id=seguros2790&client_secret=73hfyGfe
tr&grant_type=authorization_code&code=123456789&redirect_uri=myapp%3A%2F%2Fcallback
Resposta:
A resposta será um JSON com o formato definido no standart OAuth 2.0
Exemplo:
{
"access_token": "DGTKHF55GFY33FGEVCBEJTNEYFEUT",
"token_type": "bearer",
"expires_in": 43200,
"refresh_token": "RTDGTHFTEGVFJ7HFVEKFNEY725FEVFUK",
"scope": "read write"
}
O access_token devolvido terá uma validade de 12 horas.
O access_token será depois utilizado nos WebServices disponibilizados por SOAP.

O access_token deve ser utilizado num campo aplicacional com o nome access_token.
Atenção - O access_token não pode ser utilizado usando o header Authorization.

De seguinda deverá ser utilizado o refresh_token para obter novas sessões sem ser necessário pedir de
novo as credenciais ao utilizador
Os erros são devolvidos com HTTP 400, em que no body é devolvido um JSON com o formato:
{
"error": " server_error",
"error_description": " The authorization server encountered an unexpected condition
that prevented it from fulfilling the request."
}
Verificar o rfc6749 ( https://tools.ietf.org/html/rfc6749#section-5.2 )
O servidor su_webserver colocado no URL foi colocado apenas a título de exemplo.
Fluxo de autenticação "Refresh Token"
O token obtido apenas tem a duração de 12 horas, após esse período de tempo será necessário obter um
novo access_token utilizado o refresh_token obtido no Fluxo de autenticação "Authorization Code".
Desta forma não é necessário passar o utilizador de novo pelo processo de autenticação.
• client_id
• client_secret
• grant_type
o refresh_token
• refresh_token
o O refresh_token que foi obtido no fluxo de autenticação "Authorization Code".
Exemplo:
tr&grant_type=refresh_token&refresh_token=RTDGTHFTEGVFJ7HFVEKFNEY725FEVFUK
Resposta:
A resposta será um JSON com o formato definido no standart OAuth 2.0
Exemplo:
{"access_token":"DGTKHF55GFY33FGEVCBEJTNEYFEUT","token_type":"bearer","expires_in":43200,","scop
e":"read write"}
O refresh_token não é devolvido, ou seja, na próxima chamada deve ser utilizado o mesmo que foi
utilizado nesta chamada.
Se for devolvido um erro deverá ser solicitado a autorização do cliente, utilizando o fluxo de autenticação
"Authorization Code".
{
}
Fluxo de autenticação "Password Grant"
Este tipo de autenticação apenas pode ser utilizado por utilizadores aplicacionais, ou seja, utilizadores de
sistema, usados em processos Batch, não é possível efetuar autenticação desta forma com o utilizador e
password de um utilizador individual / agente.
• client_id
• client_secret
• grant_type
o password
• username
o Utilizador aplicacional
• password
o Password do utilizador aplicacional
• scope
o read write
▪ Indica qual o nivel de acesso que a aplicação esta a solicitar. Os vários parâmetros
devem ir separados com espaço, na nossa implementação é possível read e write, ou
seja read será o acesso a todos os WebServices de leitura e Write o acesso a todos os
WebServices de escrita.
Exemplo:
tr&grant_type=password&username=xpto&password=Hgtfgdtehdhd6&scope=read%20write
Resposta:
A resposta será um JSON com o formato definido no standard OAuth 2.0
Exemplo:
{"access_token":"DGTKHF55GFY33FGEVCBEJTNEYFEUT","token_type":"bearer","expires_in":43200,","scop
e":"read write"}
O refresh_token não é devolvido neste fluxo, ou seja, na próxima chamada deve ser efetuado um novo
pedido com username e password.
{
}
3. WebServices
Modo de funcionamento dos serviços para obtenção de dados
Os serviços do tipo “Obter”, ou seja, os serviços WSDG001, WSDG002, WSDG003 e WSDG004 funcionam
de forma semelhante.
Os serviços têm 3 modos de funcionamento:
1 – Por ID especifico do Objecto (NrCliente / NrApolice / Nrinistro / NrRecibo)
Caso o ID especifico do objeto seja preenchido é devolvido no output do serviço os dados relativos a esse
objeto.
2– Nenhum campo preenchido / Com SyncToken
RECOMENDADO - Este deve ser o modo preferencial para correr o serviço.
2.1 - Nenhum campo preenchido
Após o carregamento inicial (opcional) é necessário correr uma vez o serviço desta forma, ou seja, sem
nenhum campo preenchido, de forma a obter o primeiro SyncToken.
Desta forma são devolvidos todos os registos novos ou alterados nos últimos 7 dias. Se o indicador
MaisRegistos for devolvido com SIM deve efetuada uma nova chamada apenas com o SyncToken, de forma a
devolver um novo ficheiro com mais registos, este processo deve continuar até o indicador MaisRegistos for devolvido
com NAO, o SyncToken será devolvido também, este deve ser guardado na aplicação e utilizado passado
algum tempo (por exemplo no dia seguinte) para obter os novos registos criados e alterados.
2.2 - Com SyncToken
Tal como indicado previamente, desta forma são devolvidos todos registos com novos ou alterados desde
a última chamada. A lógica depois é igual ao ponto anterior, ou seja, se o indicador MaisRegistos for devolvido
com SIM deve ser efetuada uma nova chamada apenas com o SyncToken, de forma a devolver um novo ficheiro com
mais registos, este processo deve continuar até o indicador MaisRegistos for devolvido com NAO,
o SyncToken será
devolvido também, este deve ser guardado na aplicação e utilizado passado algum tempo (por exemplo
no dia seguinte) para obter os novos registos criados e alterados.
3– Por Datas (DataInicio e DataFim)
NÃO RECOMENDADO - Este modo de funcionamento apenas deve ser utilizado atipicamente.
Se os campos DataInicio e DataFim forem preenchidos são devolvidos todos os registos novos ou alterados
entre essas dadas num ficheiro, no máximo são devolvidos 7 dias de dados, se o SyncToken for devolvido e o
indicador MaisRegistos for devolvido com SIM deve ser efectuada uma nova chamada apenas com o SyncToken, de
forma a devolver um novo ficheiro com mais registos, este processo deve continuar até o indicador MaisRegistos for
devolvido com NAO, neste caso o SyncToken não será devolvido.
3.1. WSDG001_ObterClientes
Descrição
O serviço tem como objetivo devolver os dados de um cliente especifico ou devolver um ficheiro xml com
os clientes novos ou alterados desde a ultima chamada (Verificar a secção do documento - Modo de
funcionamento dos serviços para obtenção de dados).
Apenas pode ser executado por utilizadores aplicacionais.
Campos do Serviço
INPUT
Campo WS Campo Tipo Opcional? Descrição Valores Possíveis
NrCliente Número de Char(10) Sim Referencia da entidade

Cliente interna da companhia
Se for preenchido
apenas devolve os
dados desse cliente
DataInicio Data Inicio Char(10) Sim Data Inicio da AAAA-MM-DD

pesquisa Exemplo: 2019-01-01
A preencher para
devolver dados
relativos a um periodo
especifico
DataFim Data Fim Char(10) Sim Data Fim pesquisa AAAA-MM-DD

Exemplo: 2019-01-10
A preencher para
devolver dados
especifico
SyncToken Token de Sim O token deve ser
sincronização preenchido com o
valor devolvido na
última chamada.
OUTPUT
Campo WS Campo Tipo Descrição Valores Possíveis
Cliente Estrutura Contem informação

sobre o cliente
Cliente.NrCliente Número de Char(10) Referencia da entidade
Cliente interna da companhia
Cliente.Tipo Tipo de Cliente Char(01) Indica o tipo de

entidade para a
Seguradoras Unidas
Cliente.TipoDesc Descrição de Char(60)

Cliente.Tipo
Cliente.Nome Nome Cliente Varchar(116)
Cliente.MoradaResiden Estrutura
cia
Cliente.MoradaResiden Morada Cliente Varchar(46)
cia.Morada
Cliente.MoradaResiden Localidade Char(30)
cia.Localidade
Cliente.MoradaResiden Código Postal Char(08) Formato 1000-100
cia.CodPostal
Cliente.MoradaResiden Localidade Postal Char(35)
cia.LocalidadePostal
Cliente.DtNascimento Data Nascimento Char(10)
Cliente.EstadoCivil Estado Civil Char(01)
Cliente.EstadoCivilDesc Descrição de Char(60)

Cliente.EstadoCivil
Cliente.NrContribuinte Número de Char(20)
Contribuinte
Cliente.NrIdentificacao Bilhete Entidade / Char(13) Número do Bilhete de

CC entidade ou Cartão do
Cidadão
Cliente.Nacionalidade Nacionalidade Char(03)
Cliente.NacionalidadeD Descrição de Char(60)

esc Cliente.Nacionalid
ade
Cliente.HabilitacoesLite Habilitações Char(01)
rarias Literárias
Cliente.HabilitacoesLite Descrição de Char(60)

rariasDesc Cliente.Habilitacoe
sLiterarias
Cliente.Profissao Profissão Char(06) Profissão
Cliente.ProfissaoDesc Descrição de
Cliente.Profissao
Cliente.Contactos[] Lista de Array (Max 3) Contactos da entidade
Estruturas
Cliente.Contactos[].Co Contato Char(16) Contato

ntacto
Cliente.Emails[] Lista de Array (MAX 10) Contactos eletrónicos do
Estruturas cliente
Cliente.Emails[].TipoEma Tipo de Email Char(01) Tipo de email da

il entidade
Cliente.Emails[].TipoEma Descrição do Char(60)

ilDesc Cliente.Emails[].Tip
oEmail
Cliente.Emails[].Email Email Char(250) Email do Cliente
Cliente.CartaConducao Estrutura
Cliente.CartaConducao Número Carta Char(10)

.NrCartaConducao Condução
Cliente.CartaConducao Lista de Estruturas Array(Max 10) Informação da carta de

.Detalhes[] Condução da entidade
Cliente.CartaConducao Tipo de Carta Char(02)

.Detalhes[].Tipo
Cliente.CartaConducao Descrição do Char(60)

.Detalhes[].TipoDesc Cliente.CartaCond
ucao.Detalhes[].Ti
po
Cliente.CartaConducao Data Carta Char(10)
.Detalhes[].Data Condução
Cliente.Sexo Sexo Char(01)
Cliente.SexoDesc Descrição do Char(60)

Cliente.Sexo
Cliente.CAE CAE Char(05) Código de atividade
económica
Cliente.NrEmpregados Número de Char(05) Número de empregados

empregados da entidade coletiva
Cliente.NrEmpregados Descrição Número Char(60)

Desc de Empregados
Cliente.AnoInicioActivi Ano Início da Char(04)

dade atividade
Cliente.IndEntidadeVer Indicador de Char(03) Indica se entidade é SIM / NAO

de entidade Verde desmaterializada, ou
seja, recebe
documentação digital.
Cliente.DataEntidadeV Data de Char(10) Data a partir da qual a

erde desmaterialização entidade aderiu a
entidade verde
Ficheiro Ficheiro Binário em Ficheiro XML com a lista Verificar Formato do
formato Gzip com objectos. (Com ficheiro XML em
o xml compressão Gzip) baixo
MaisRegistos Indica se há mais Char(03) Indica se é necessário SIM / NAO
registos para efetuar mais uma
devolver. chamada ao serviço
para obter os próximos
registos (usando o token
devolvido)
SyncToken Token de Token que indica o
Sincronização estado da sincronização,
deve ser utilizado para
obter os próximos
registos. Quando o
indicador MaisRegistos
vem a NAO este token é
devolvido e deve ser
utilizado na chamada do
dia seguinte para obter
o delta dos registos
criados entretanto.
Ficheiro XML - Exemplo
<Lista>
<Cliente>
<NrCliente></NrCliente>
<Tipo></Tipo>
<TipoDesc></TipoDesc>
<Nome></Nome>
<MoradaResidencia>
<Morada></Morada>
<Localidade></Localidade>
<CodPostal></CodPostal>
<LocalidadePostal></LocalidadePostal
</MoradaResidencia>
<DtNascimento></DtNascimento>
<EstadoCivil></EstadoCivil
<EstadoCivilDesc></EstadoCivilDesc>
<NrContribuinte></NrContribuinte>
<NrIdentificacao></NrIdentificacao>
<Nacionalidade></Nacionalidade>
<NacionalidadeDesc></NacionalidadeDesc>
<HabilitacoesLiterarias></HabilitacoesLiterarias>
<HabilitacoesLiterariasDesc></HabilitacoesLiterariasDesc>
<Profissao></Profissao>
<ProfissaoDesc></ProfissaoDesc>
<Contactos>
<Contacto></Contacto>
</Contactos>
<Contactos>
<Contacto></Contacto>
</Contactos>
<Emails>
<TipoEmail></TipoEmail>
<TipoEmailDesc></TipoEmailDesc>
<Email></Email>
</Emails>
<Emails>
<TipoEmail></TipoEmail>
<TipoEmailDesc></TipoEmailDesc>
<Email></Email>
</Emails>
<CartaConducao>
<NrCartaConducao>
<Detalhes>
<Tipo></Tipo>
<Data></Data>
</Detalhes>
<Detalhes>
<Tipo></Tipo>
<Data></Data>
</Detalhes>
</CartaConducao>
<Sexo></Sexo>
<SexoDesc></SexoDesc>
<CAE></CAE>
<NrEmpregados></NrEmpregados>
<NrEmpregadosDesc></NrEmpregadosDesc>
<AnoInicioActividade></AnoInicioActividade>
<IndEntidadeVerde></IndEntidadeVerde>
<DataEntidadeVerde></DataEntidadeVerde>
</Cliente>
</Lista>
A Tag Cliente é uma lista, ou seja, pode ser repetida várias vezes.
As Tags repetidas são listas (Contactos, Emails, Detalhes)
3.2. WSDG002_ObterApolices
Descrição
O serviço tem como objetivo devolver os dados de uma apólice especifica ou devolver um ficheiro xml com
as apólices novas ou alteradas desde a ultima chamada (Verificar a secção do documento - Modo de
Campos do Serviço
INPUT
NrApolice Número da Char(16) Sim Número da Apólice

Apólice
Se for preenchido apenas
devolve os dados dessa
apólice
DataInicio Data Inicio Char(10) Sim Data Inicio da pesquisa AAAA-MM-DD

Exemplo: 2019-01-01
A preencher para devolver
dados relativos a um
periodo especifico

Exemplo: 2019-01-10
A preencher para devolver
dados relativos a um
periodo especifico

sincronização preenchido com o valor
devolvido na última
chamada.
OUTPUT
Campo WS Campo Tipo Descrição Valores
Possíveis
Apolice Estrutura Dados da apólice

Apolice.NrApolice Número da Apólice Char(16) Número apólice
Apolice.Produto Produto Char(05) Produto da apólice Formato NNNNN -

XXXXXXXX onde
NNNNN será o
código do produto
e o XXXXXXXX a
descrição.
Sem valores
predefinidos.
Apolice.ProdutoDesc Descrição de Char(60) Sem tabela, é

Apolice.Produto apenas uma
descrição.
Apolice.Opcao Opção Char(02) Opção dentro do Formato NN -
produto XXXXXXXX onde
NN será o código
da opção e o
XXXXXXXX a
descrição
Sem valores
predefinidos.
Apolice.OpcaoDesc Descrição de Char(60) Sem tabela, é

Apolice.Opcao apenas uma
descrição.
Apolice.NrTomador Número de tomador Char(10) Número da Referencia da
entidade tomadora entidade interna da
do seguro companhia.
Apolice.EstadoApolice Estado da apólice Char(02)
Apolice.EstadoApoliceD Descrição de Char(60)

esc Apolice.EstadoApolice
Apolice.Fracionamento Fracionamento Char(02) Fracionamento do
contrato
Apolice.Fracionamento Descrição de Char(60)

Desc Apolice.Fracionamento
Apolice.DtInicioApolice Data início da apólice Char(10) Data de início do Formato AAAA-MM-
contrato DD.
Apolice.DtFimApolice Data fim da apólice Char(10) Data fim da apólice. Formato AAAA-MM-
DD. Só vira com
data significativa
quando o estado
do contrato for
anulado. Em caso
contrário 9999-12-
31
Apolice.DtInicioPeriodo Data início do período Char(10) Data início do Formato AAAA-MM-

período DD.
Apolice.DtFimPeriodo Data fim do período Char(10) Data fim do período Formato AAAA-MM-
DD
Apolice.DtVencimentoA Data de vencimento da Char(10) Data de vencimento Formato AAAA-MM-

police apólice da apólice DD
Apolice.MotivoAlteraca Motivo de Alteração Char(02) Motivo da última

o alteração à apólice
Apolice.MotivoAlteraca Descrição de Char(60)

oDesc Apolice.MotivoAlteracao
Apolice.MoradaCorresp Estrutura
ondencia
Apolice.MoradaCorresp Morada de Char(45) Morada para a qual
ondencia.Morada correspondência da será enviada a
apólice documentação do
contrato
Apolice.MoradaCorresp Localidade Char(30)

ondencia.Localidade
Apolice.MoradaCorresp Código Postal Char(08) Formato 1000-100
ondencia.CodPostal
Apolice.MoradaCorresp Localidade Postal Char(45)
ondencia.LocalidadePo
stal
Apolice.NrAcaoMarketi Número da acção de Char(03)
ng marketing
Apolice.CapitalApolice Capital da apólice Decimal(15,2) Capital contratado

da apólice
Apolice.PremioTotal Premio Total Decimal(15,2) Prémio total
Apolice.ContaCobranca Conta Cobrança Char(10)
Apolice.NomeTomador Nome Tomador Char(45)
Apolice.NrContribuinte Numero Contribuinte Char(20)
Apolice.ObjetosSeguro Lista de Estruturas Array(de 0 a Linhas de

s[] Infin) Negocio/ObjetosSe
guros
Apolice.ObjetosSeguro Linha de Negócio Char(05) Linha de negócio Sem valores

s[].LinhaNegocio predefinidos.
Apolice.ObjetosSeguro Descrição de Char(60) Sem tabela, é

s[].LinhaNegocioDesc Apolice.ObjetosSeguros[ apenas uma
].LinhaNegocio descrição.
Apolice.ObjetosSeguro Nº Objeto Char(03) Identificação do
s[].NrObjeto Objeto Seguro
Apolice.ObjetosSeguro Tipo de Objecto Char(02) Tipo de Objeto

s[].TipoObjeto Seguro
Apolice.ObjetosSeguro Descrição do Char(60)

s[].TipoObjetoDesc Apolice.ObjetosSeguros[
].TipoObjeto
Apolice.ObjetosSeguro Sub Tipo do Objeto Char(01)
s[].SubTipoObjeto
Apolice.ObjetosSeguro Descrição do Char(60)
s[].SubTipoObjetoDesc Apolice.ObjetosSeguros[
].SubTipoObjeto
Apolice.ObjetosSeguro Capital Decimal(11,2) Capital do Objeto
s[].Capital Seguro
Apolice.ObjetosSeguro Estrutura
s[].LocalRisco
Apolice.ObjetosSeguro Local Risco Char(45) Local de Risco Morada completa
s[].LocalRisco.Morada do local de risco
Apolice.ObjetosSeguro Localidade do Local de Char(30) Localidade

s[].LocalRisco.Localida Risco
de
Apolice.ObjetosSeguro Código Postal do Local Char(08) Código Postal do Formato 1000-100
s[].LocalRisco.CodPost de Risco Local de Risco
al
Apolice.ObjetosSeguro Data Construção Char(10) Formato AAAA-MM-
s[].DtConstrucao DD
Apolice.ObjetosSeguro Percentagem de Decimal(5,2)
s[].PercentagemIndex Indexação
acao
Apolice.ObjetosSeguro Número de Pessoa Char(10) Número da
s[].NrPessoaSegura Segura entidade tomadora
do seguro
Apolice.ObjetosSeguro Nome da Pessoa Segura Char(45)

s[].NomePessoaSegura
Apolice.ObjetosSeguro Matrícula Char(15)
s[].Matricula
Apolice.ObjetosSeguro Data da Matrícula Char(10)
s[].DtMatricula
Apolice.ObjetosSeguro Categoria Char(02)
s[].Categoria
Apolice.ObjetosSeguro Descrição de Char(60)
s[].CategoriaDesc Apolice.ObjetosSeguros[
].Categoria
Apolice.ObjetosSeguro Tipo de Matrícula Char(01)
s[].TipoMatricula
s[].TipoMatriculaDesc Apolice.ObjetosSeguros[
].TipoMatricula
Apolice.ObjetosSeguro Marca Char(30)
s[].Marca
Apolice.ObjetosSeguro Modelo Char(30)
s[].Modelo
Apolice.ObjetosSeguro Versão Char(30)
s[].Versao
Apolice.ObjetosSeguro Número de Lugares Char(04)
s[].NrLugares
Apolice.ObjetosSeguro Potencia Char(04)
s[].Potencia
Apolice.ObjetosSeguro Prémio Comercial Decimal(15,2)
s[].PremioComercial
Apolice.ObjetosSeguro Código de Mediação Char(10)
s[].CodigoMediacao
Apolice.ObjetosSeguro Modo de Renovação Char(01)
s[].ModoRenovacao
s[].ModoRenovacaoDe Apolice.ObjetosSeguros[
sc ].ModoRenovacao
Ficheiro Ficheiro Binário em formato Ficheiro XML com a Verificar Formato
Gzip com o xml lista objetos. (Com do ficheiro XML em
compressão Gzip) baixo
MaisRegistos Indica se há mais Char(03) Indica se é SIM / NAO
registos para devolver. necessário efetuar
mais uma chamada
ao serviço para
obter os próximos
registos (usando o
token devolvido)
SyncToken Token de Sincronização Token que indica o
estado da
sincronização, deve
ser utilizado para
obter os próximos
registos. Quando o
indicador
MaisRegistos vem a
NAO este token é
devolvido e deve
ser utilizado na
chamada do dia
seguinte para obter
o delta dos registos
criados entretanto.

<Lista>
<Apolice>
<NrApolice></NrApolice>
<Produto></Produto>
<ProdutoDesc></ProdutoDesc>
<Opcao></Opcao>
<OpcaoDesc></OpcaoDesc>
<NrTomador></NrTomador>
<EstadoApolice></EstadoApolice>
<EstadoApoliceDesc></EstadoApoliceDesc>
<Fracionamento></Fracionamento>
<FracionamentoDesc></FracionamentoDesc>
<DtInicioApolice></DtInicioApolice>
<DtFimApolice></DtFimApolice>
<DtInicioPeriodo></DtInicioPeriodo>
<DtFimPeriodo></DtFimPeriodo>
<DtVencimentoApolice></DtVencimentoApolice>
<MotivoAlteracao></MotivoAlteracao>
<MotivoAlteracaoDesc></MotivoAlteracaoDesc>
<MoradaCorrespondencia>
<Morada></Morada>
<LocalidadePostal></LocalidadePostal>
</MoradaCorrespondencia>
<NrAcaoMarketing></NrAcaoMarketing>
<CapitalApolice></CapitalApolice>
<PremioTotal></PremioTotal>
<ContaCobranca></ContaCobranca>
<NomeTomador></NomeTomador>
<NrContribuinte></NrContribuinte>
<ObjetosSeguros>
<LinhaNegocio></LinhaNegocio>
<LinhaNegocioDesc></LinhaNegocioDesc>
<NrObjeto></NrObjeto>
<TipoObjeto></TipoObjeto>
<TipoObjetoDesc></TipoObjetoDesc>
<SubTipoObjeto></SubTipoObjeto>
<SubTipoObjetoDesc></SubTipoObjetoDesc>
<Capital></Capital>
<LocalRisco>
<Morada></Morada>
</LocalRisco>
<DtConstrucao></DtConstrucao>
<PercentagemIndexacao></PercentagemIndexacao>
<NrPessoaSegura></NrPessoaSegura>
<NomePessoaSegura></NomePessoaSegura>
<Matricula></Matricula>
<DtMatricula></DtMatricula>
<Categoria></Categoria>
<CategoriaDesc></CategoriaDesc>
<TipoMatricula></TipoMatricula>
<TipoMatriculaDesc></TipoMatriculaDesc>
<Marca></Marca>
<Modelo></Modelo>
<Versao></Versao>
<NrLugares></NrLugares>
<Potencia></Potencia>
<PremioComercial></PremioComercial>
<CodigoMediacao></CodigoMediacao>
<ModoRenovacao></ModoRenovacao>
<ModoRenovacaoDesc></ModoRenovacaoDesc>
</ObjetosSeguros>
<ObjetosSeguros>
<LinhaNegocio></LinhaNegocio>
<LinhaNegocioDesc></LinhaNegocioDesc>
<NrObjeto></NrObjeto>
<TipoObjeto></TipoObjeto>
<TipoObjetoDesc></TipoObjetoDesc>
<SubTipoObjeto></SubTipoObjeto>
<SubTipoObjetoDesc></SubTipoObjetoDesc>
<Capital></Capital>
<LocalRisco>
<Morada></Morada>
</LocalRisco>
<PercentagemIndexacao></PercentagemIndexacao>
<NrPessoaSegura></NrPessoaSegura>
<NomePessoaSegura></NomePessoaSegura>
<DtMatricula></DtMatricula>
<CategoriaDesc></CategoriaDesc>
<Marca></Marca>
<Modelo></Modelo>
<Versao></Versao>
<NrLugares></NrLugares>
<Potencia></Potencia>
<CodigoMediacao></CodigoMediacao>
<ModoRenovacao></ModoRenovacao>
<ModoRenovacaoDesc></ModoRenovacaoDesc>
</ObjetosSeguros>
</Apolice>
</Lista>
A Tag Apolice é uma lista, ou seja, pode ser repetida várias vezes.
As Tags repetidas são listas (ObjetosSeguros)
3.3. WSDG003_ObterRecibos
Descrição
O serviço tem como objetivo devolver os dados de um recibo especifico ou devolver um ficheiro xml com
os recibos novos ou alterados desde a ultima chamada (Verificar a secção do documento - Modo de
Campos do Serviço
INPUT
NrRecibo Número do Char(10) Sim Referencia do recibo

Recibo interna da companhia
Se for preenchido
apenas devolve os
dados desse recibo.

A preencher para
devolver dados
especifico

Exemplo: 2019-01-10
A preencher para
devolver dados
especifico

valor devolvido na
última chamada.
OUTPUT
Recibo Estrutura Dados do recibo

Recibo.NrRecibo Número de Recibo Char(10) Referencia do
recibo interna da
companhia
Recibo.TipoRecibo Tipo de Recibo Char(02) Tipo de Recibo

Emitido
Recibo.TipoReciboDesc Descrição de Char(60)

Recibo.TipoRecibo
Recibo.NrApolice Número da Apólice Char(20) Número apólice
Recibo.EstadoRecibo Estado do Recibo Char(02)
Recibo.EstadoReciboDesc Descrição de Char(60)

Recibo.EstadoRecibo
Recibo.DtEmissao Data de Emissão Char(10) Formato
AAAA-MM-DD
Recibo.DtInicio Data de Início Char(10) Formato
AAAA-MM-DD
Recibo.DtFim Data Fim Char(10) Formato AAAA-MM-

DD
Recibo.DtLimiteCobranca Data de Limite de Char(10) Formato AAAA-MM-

Cobrança DD
Recibo.DtPagamento Data de Pagamento Char(10) Formato
AAAA-MM-DD
Recibo.PremioLiquido Premio Líquido Decimal(15,2) Formato
9999999999999.99
Recibo.PremioTotal Prémio Total Decimal(15,2) Formato

9999999999999.99
Recibo.PremioComercial Prémio Comercial Decimal(14,2) Formato

9999999999999.99
Recibo.CodCobrador Código Cobrador Char(10)
Recibo.ComissaoCobranca Comissão de Cobrança Decimal(13,2) Formato
9999999999999.99
Recibo.IrsRetidoCobranca Irs Retido Cobrança Decimal(13,2) Formato
9999999999999.99
Recibo.CodMediador Código mediador Char(10)
Recibo.ComissaoMediacao Comissão de mediação Decimal(13,2) Formato
9999999999999.99
Recibo.IrsRetidoMediacao Irs Retido mediação Decimal(13,2) Formato
9999999999999.99
Recibo.SeloMediador Selo Mediador Decimal(13,2)
Recibo.SeloCobrador Selo Cobrador Decimal(13,2)

Recibo.TemCheque Tem Cheque Char(03) SIM / NAO
Recibo.NrCheque Número de Cheque Char(10)
Recibo.DtEmissaoCheque Data Emissão do Char(10) Formato

Cheque
AAAA-MM-DD
Recibo.ReciboPertenceExtrato Recibo pertence a Char(03) SIM / NAO

extrato
Recibo.NrExtrato Número de Extrato Char(08)
Recibo.NrTomador Número Tomador Char(10)

associado ao recibo
Recibo.TipoRecebimento Forma como o recibo foi Char(02)
cobrado
Recibo.TipoRecebimentoDesc Descrição Char(60) Caso
Recibo.TipoRecebimento TipoRecebimento=PC
vem o numero de
lote ou o numero de
prestação de contas
do Sia.Net
Recibo.ATM Estrutura Estrutura para
pagamento ATM o
montante será o
campo
Recibo.PremioTotal
Recibo.ATM.Entidade Entidade ATM Char(5)
Recibo.ATM.Referencia Referencia ATM Char(9)
Ficheiro Ficheiro Binário em Ficheiro XML com Verificar Formato do
formato Gzip a lista objetos. ficheiro XML em
com o xml (Com compressão baixo
Gzip)
MaisRegistos Indica se há mais Char(03) Indica se é SIM / NAO
registos para devolver. necessário efetuar
mais uma
chamada ao
serviço para obter
os próximos
registos (usando o
token devolvido)
estado da
sincronização,
deve ser utilizado
para obter os
próximos registos.
Quando o
indicador
MaisRegistos vem
a NAO este token
é devolvido e deve
ser utilizado na
chamada do dia
seguinte para
obter o delta dos
registos criados
entretanto.
<Lista>
<Recibo>
<NrRecibo></NrRecibo>
<TipoRecibo></TipoRecibo>
<TipoReciboDesc></TipoReciboDesc>
<EstadoRecibo></EstadoRecibo>
<EstadoReciboDesc></EstadoReciboDesc>
<DtEmissao></DtEmissao>
<DtInicio></DtInicio>
<DtFim></DtFim>
<DtLimiteCobranca></DtLimiteCobranca>
<DtPagamento></DtPagamento>
<PremioLiquido></PremioLiquido>
<PremioTotal></PremioTotal>
<CodCobrador></CodCobrador>
<ComissaoCobranca></ComissaoCobranca>
<IrsRetidoCobranca></IrsRetidoCobranca>
<CodMediador></CodMediador>
<ComissaoMediacao></ComissaoMediacao>
<IrsRetidoMediacao></IrsRetidoMediacao>
<SeloMediador></SeloMediador>
<SeloCobrador></SeloCobrador>
<TemCheque></TemCheque>
<NrCheque></NrCheque>
<DtEmissaoCheque></DtEmissaoCheque>
<ReciboPertenceExtrato></ReciboPertenceExtrato>
<NrExtrato></NrExtrato>
<NrTomador></NrTomador>
<TipoRecebimento></TipoRecebimento>
<TipoRecebimentoDesc></TipoRecebimentoDesc>
<ATM>
<Entidade></Entidade>
<Referencia></Referencia>
</Recibo>
</Lista>
A Tag Recibo é uma lista, ou seja, pode ser repetida várias vezes.
3.4. WSDG004_ObterSinistros
Descrição
O serviço tem como objetivo devolver os dados de um Sinistro especifico ou devolver um ficheiro xml com
os Sinistros novos ou alterados desde a ultima chamada (Verificar a secção do documento - Modo de
Apenas deve ser utilizado por utilizadores aplicacionais.
Campos do Serviço
INPUT
NrOcorrencia Número da Char(10) Sim Referencia da

Ocorrência ocorrência
interna da
companhia
Se for preenchido
apenas devolve
os dados dessa
ocorrência e
sinistros
associados.
NrSinistro Número do Char(10) Sim Referencia do

Sinistro sinistro interno
da companhia
Se for preenchido
apenas devolve
os dados desse
sinistro e da
ocorrência
associada.

A preencher para
devolver dados
relativos a um
periodo especifico
DataFim Data Fim Char(10) Sim Data Fim AAAA-MM-DD
A preencher para
devolver dados
relativos a um
período especifico

valor devolvido
na última
chamada.
OUTPUT
Possíveis
Ocorrencia Estrutura
Ocorrencia.NrOcorrencia Número da ocorrência Char(10) Referencia da
ocorrência interna da
companhia
Ocorrencia.NrApolice Número da Apólice Char(16) Número apólice
Ocorrencia.EstadoOcorren Estado da ocorrência Char(01) Estado da ocorrência

cia
Ocorrencia.EstadoOcorren Descrição de Char(60)
ciaDesc Ocorrencia.EstadoOcorrencia
Ocorrencia.DtOcorrencia Data da Ocorrência Char(10) Data da ocorrência Formato
AAAA-MM-DD
Ocorrencia.DtEncerramen Data de encerramento da Char(10) Data de Formato

toOcorrencia ocorrência encerramento da
AAAA-MM-DD
ocorrência
Ocorrencia.Produto Produto Char(05) Sem valores

predefinidos.
Ocorrencia.ProdutoDesc Char(60) Sem tabela, é
apenas uma
descrição.
Ocorrencia.NrReclamante Número de reclamante Char(10) Número da entidade
reclamante da
ocorrência
Ocorrencia.NomeReclama Nome do Reclamante Varchar(11

nte 6)
Ocorrencia.DtRececao Data de receção Char(10) Data de receção da Formato

ocorrência na
companhia AAAA-MM-DD
Ocorrencia.CodAcidente Código do Acidente Char(05) Código do acidente

Ocorrencia.CodAcidenteD Descrição de Char(60)
esc Ocorrencia.CodAcidente
Ocorrencia.DescOcorrenci Descritivo da ocorrência Char(50)
a
Ocorrencia.CodConcelhoI Código do concelho ISP Char(03)
SP
Ocorrencia.CodConcelhoI Descritivo do concelho ISP Char(60)
SPDesc
Ocorrencia.Sinistros[] Lista de Estruturas Array(De 0 Sinistros relacionados
a infin) com a ocorrência
Ocorrencia.Sinistros[].NrSi Número de Sinistro Char(10) Referencia do sinistro

nistro interna da
companhia
Ocorrencia.Sinistros[].Tip Tipo de Gestão Char(05) Tipo de gestão do Sem valores

oGestao sinistro predefinidos.
Ocorrencia.Sinistros[].Tip Descrição do Char(60) Sem tabela, é

oGestaoDesc Ocorrencia.Sinistros[].TipoGe apenas uma
stao descrição.
Ocorrencia.Sinistros[].Cod Código do tipo de sinistro Char(05)

TipoSinistro
Ocorrencia.Sinistros[].Cod Descrição do Char(60)
TipoSinistroDesc Ocorrencia.Sinistros[].CodTip
oSinistro
Ocorrencia.Sinistros[].Est Estado do Sinistro Char(01)
adoSinistro
Ocorrencia.Sinistros[].Est Descrição do Char(60)
adoSinistroDesc Ocorrencia.Sinistros[].Estado
Sinistro
Ocorrencia.Sinistros[].NrO Número do Objeto afetado Char(03)
bjectoAfetado
Ocorrencia.Sinistros[].Linh Linha de negócio afetada Char(05)
aNegocioAfetada
Ocorrencia.Sinistros[].DtE Data de Entrada Char(10) Data de registo no
ntrada sistema
Ocorrencia.Sinistros[].DtR Data de Reabertura Char(10) Data de reabertura Formato

eabretura do sinistro
AAAA-MM-DD
Ocorrencia.Sinistros[].Raz Razão de Reabertura Char(10) Razão da reabertura

aoReabretura do sinistro
Ocorrencia.Sinistros[].Raz Descrição de Char(60)

aoReabreturaDesc Ocorrencia.Sinistros[].RazaoR
eabretura
Ocorrencia.Sinistros[].DtE Data de Encerramento do Char(10) Formato
ncerramentoSinistro Sinistro
AAAA-MM-DD
Ocorrencia.Sinistros[].DtR Data de Re-Encerramento Char(10) Data de

eEncerramento encerramento
caso o sinistro
tenha sido
reaberto
Ocorrencia.Sinistros[].Indi Índice de agravamento ou Char(03) SIM / NAO

ceAgravamentoDesconto desconto
Ocorrencia.Sinistros[].Mat Matrícula Char(15) Matrícula afeta ao

ricula sinistro
Ocorrencia.Sinistros[].Tip Tipo de Matrícula Char(01)

oMatricula
Ocorrencia.Sinistros[].Tip Descrição de Char(60)
oMatriculaDesc Ocorrencia.Sinistros[].TipoMa
tricula
Ocorrencia.Sinistros[].DtC Data de construção Char(10)
onstrucao
Ocorrencia.Sinistros[].Mar Marca CHAR(30)
ca
Ocorrencia.Sinistros[].Mo Modelo CHAR(30)
delo
Ocorrencia.Sinistros[].Ver Versão CHAR(30)
sao
Ocorrencia.Sinistros[].Cha Chassis CHAR(16)
ssis
Ocorrencia.Sinistros[].Cat Categoria CHAR(02)
egoria
Ocorrencia.Sinistros[].Cat Descrição de
egoriaDesc Ocorrencia.Sinistros[].Catego
ria
Ocorrencia.Sinistros[].Km Km à data de Ocorrência Int
DataOcorrencia
Ocorrencia.Sinistros[].Val Valor do Salário Decimal(13,
orSalario 2)
Ocorrencia.Sinistros[].Val Valor do subsídio de Decimal(13,

orSubsidioAlimentacao alimentação 2)
Ocorrencia.Sinistros[].Val Valor do sinistro Decimal(13,

orSinistro 2)
Ficheiro Ficheiro Binário em Ficheiro XML com a Verificar

formato Gzip lista objetos. (Com Formato do
com o xml compressão Gzip) ficheiro XML em
baixo
MaisRegistos Indica se há mais registos CHAR(03) Indica se é SIM / NAO
para devolver. necessário efetuar
mais uma chamada
ao serviço para obter
os próximos registos
(usando o token
devolvido)
estado da
ser utilizado para
obter os próximos
registos. Quando o
indicador
MaisRegistos vem a
NAO este token é
devolvido e deve ser
utilizado na chamada
do dia seguinte para
obter o delta dos
registos criados
entretanto.
<Lista>
<Ocorrencia>
<NrOcorrencia></NrOcorrencia>
<EstadoOcorrencia></EstadoOcorrencia>
<EstadoOcorrenciaDesc></EstadoOcorrenciaDesc>
<DtOcorrencia></DtOcorrencia>
<DtEncerramentoOcorrencia></DtEncerramentoOcorrencia>
<Produto></Produto>
<ProdutoDesc></ProdutoDesc>
<NrReclamante></NrReclamante>
<NomeReclamante></NomeReclamante>
<DtRececao></DtRececao>
<CodAcidente></CodAcidente>
<CodAcidenteDesc></CodAcidenteDesc>
<DescOcorrencia></DescOcorrencia>
<CodConcelhoISP></CodConcelhoISP>
<CodConcelhoISPDesc></CodConcelhoISPDesc>
<Sinistros>
<NrSinistro></NrSinistro>
<TipoGestao></TipoGestao>
<TipoGestaoDesc></TipoGestaoDesc>
<CodTipoSinistro></CodTipoSinistro>
<CodTipoSinistroDesc></CodTipoSinistroDesc>
<EstadoSinistro></EstadoSinistro>
<EstadoSinistroDesc></EstadoSinistroDesc>
<NrObjectoAfetado></NrObjectoAfetado>
<LinhaNegocioAfetada></LinhaNegocioAfetada>
<DtEntrada></DtEntrada>
<DtReabretura></DtReabretura>
<RazaoReabretura></RazaoReabretura>
<RazaoReabreturaDesc></RazaoReabreturaDesc>
<DtEncerramentoSinistro></DtEncerramentoSinistro>
<DtReEncerramento></DtReEncerramento>
<IndiceAgravamentoDesconto></IndiceAgravamentoDesconto>
<Marca></Marca>
<Modelo></Modelo>
<Versao></Versao>
<Chassis></Chassis>
<KmDataOcorrencia></KmDataOcorrencia>
<ValorSalario></ValorSalario>
<ValorSubsidioAlimentacao></ValorSubsidioAlimentacao>
<ValorSinistro></ValorSinistro>
</Sinistros>
<Sinistros>
<NrSinistro></NrSinistro>
<TipoGestao></TipoGestao>
<TipoGestaoDesc></TipoGestaoDesc>
<CodTipoSinistro></CodTipoSinistro>
<CodTipoSinistroDesc></CodTipoSinistroDesc>
<EstadoSinistro></EstadoSinistro>
<EstadoSinistroDesc></EstadoSinistroDesc>
<NrObjectoAfetado></NrObjectoAfetado>
<LinhaNegocioAfetada></LinhaNegocioAfetada>
<DtEntrada></DtEntrada>
<DtReabretura></DtReabretura>
<RazaoReabretura></RazaoReabretura>
<RazaoReabreturaDesc></RazaoReabreturaDesc>
<DtEncerramentoSinistro></DtEncerramentoSinistro>
<DtReEncerramento></DtReEncerramento>
<IndiceAgravamentoDesconto></IndiceAgravamentoDesconto>
<Marca></Marca>
<Modelo></Modelo>
<Versao></Versao>
<Chassis></Chassis>
<KmDataOcorrencia></KmDataOcorrencia>
<ValorSalario></ValorSalario>
<ValorSubsidioAlimentacao></ValorSubsidioAlimentacao>
<ValorSinistro></ValorSinistro>
</Sinistros>
</Ocorrencia>
</Lista>
A Tag Ocorrencia é uma lista, ou seja, pode ser repetida várias vezes.
As Tags repetidas são listas (Sinistros)
3.5. WSDG005_CobrarRecibo
Descrição
O serviço tem como objetivo comunicar a boa cobrança de um recibo.
Apenas pode ser executado por um utilizador individual / agente.

Campos do Serviço
INPUT
NrRecibo Número do Char(10) Não Referencia da

Recibo ocorrência interna da
companhia
ValorRecibo Valor do Decimal(15,2) Não Valor do recibo Formato ponto

Recibo Exemplo: 10.00
NrApolice Número da Char(16) Não Número da Apólice

Apólice
OUTPUT
Apenas os campos de sistema (ReturnValue, Estrutura Error e LogID)
3.6. WSDG006_ObterDocumentoRecibo
Descrição
O serviço tem como objetivo receber o documento aviso, comprovativo de pagamento, ou fatura relativos
ao recibo em questão consoante o estado do recibo em formato PDF.
Campos do Serviço
INPUT
NrRecibo Número do Char(10) Não Referencia da

Recibo ocorrência interna da
companhia
ValorRecibo Valor do Decimal(15,2) Não Valor do recibo Formato ponto

recibo Exemplo: 10.00

Apólice
Tipo Tipo do Char(32) Sim Tipicamente este AVISO, COMPROVATIVO
recibo campo não deve ser
preenchido. No caso
de ser
desmaterializado é
possível pedir o
comprovativo sem ter
dado o recibo como
pago.
OUTPUT
Ficheiro binário Documento em formato PDF
3.7. WSDG007_ObterDocumentoCartaVerde
Descrição
O serviço tem como objetivo receber a Carta Verde em ficheiro formato PDF.
Se o veículo tiver algum atrelado, o documento PDF será a união das várias cartas verdes correspondentes
aos vários atrelados associados ao veículo principal.
Em casos de apólices de grupo com mais do que um veículo seguro, é necessário enviar a matrícula, ou
então o número de apólice com 16 dígitos. (Número de Apólice 10 dígitos + Número de Participante 6
dígitos).
Campos do Serviço
INPUT
NrRecibo Número do Char(10) Não Número do recibo.

Recibo
NrApolice Número da Char(16) Não Número da Apólice Formato ponto

Apólice Exemplo: 10.00
Matricula Número da Char(16) Sim Matricula, necessário

Matricula em apólices de grupo
OUTPUT
3.8. WSDG008_CarregamentoInicial
Descrição
O serviço tem como objetivo obter os dados de histórico para as contas especificadas.
Campos do Serviço
INPUT
Contas Lista de Char(7) Não Lista de contas,

contas para as quais
vamos obter o
histórico
Tipo Tipo de Enumerado Não Tipo de dados a Clientes, Apolices, Recibos,

dados a obter Sinistros
obter

valor devolvido na
última chamada.
OUTPUT
Ficheiro Ficheiro Binário Ficheiro XML com a lista objetos. Se Tipo “Clientes”
em (Com compressão Gzip) formato de XML igual ao
formato serviço WSDG001.
Gzip
com o Se Tipo “Apolices”
xml formato de XML igual ao
serviço WSDG002.
Se Tipo “Recibos”
formato de XML igual ao
serviço WSDG003.
Se Tipo “Sinistros”
formato de XML igual ao
serviço WSDG004.
MaisRegistos Indica se há Indica se é necessário efetuar SIM / NAO
mais registos mais uma chamada ao serviço
para para obter os próximos registos
devolver. (usando o token devolvido)
SyncToken Token de Token que indica o estado da
Sincronização sincronização, deve ser utilizado
para obter os próximos registos.
Este token não pode ser utilizado
nos serviços WSDG001,
WSDG002, WSDG003e
WSDG004 para obter os deltas.
Quando o indicador MaisRegistos
vem a NÃO este token já não
será devolvido.
Os ficheiros têm o mesmo formato dos serviços WSDG001, WSDG002, WSDG003 e WSDG004 consoante o
tipo de ficheiro escolhido.
3.9. WSDG009_ObterExtrato
Descrição
O serviço tem como objetivo fornecer o extrato de um terminado mês para uma determinada conta.
Campos do Serviço
INPUT
Conta Conta Char(7) Não Conta para a qual

vamos obter o
extrato.
Ano Ano Char(4) Não Ano para o qual Formato AAAA

vamos obter o Exemplo 2019
extrato
Mes Mês Char(2) Não Mês para o qual Formato MM
vamos obter o Exemplo 02
extrato
Formato Formato Char(3) Não Formato do ficheiro PDF
de output XLS
OUTPUT
Ficheiro Ficheiro Binário Ficheiro PDF ou XLS com a lista

de movimentos.
3.10. WSDG010_ObterExtratoRecibosNaoCobradosTecnicamente
Descrição
O serviço tem como objetivo fornecer todas as listagens de recibos não cobrados nos prazos legais,
anulados ou cancelados tecnicamente para um determinado ano/mês em formato PDF, devolvidos num
ficheiro zip. Esta data pesquisada corresponde à data de quando as listagens foram emitidas e não à data
do conteúdo das mesmas e apenas permite a pesquisa dos ultimos 6 meses à data atual.
Campos do Serviço
INPUT

vamos obter as
listagens.

vamos obter as Exemplo 2019
listagens.

listagens.
OUTPUT
zipFile zipFile Binário Ficheiro zip com os PDF das

listagens.
3.11. WSDG011_ObterExtratoResolucaoContratos
Descrição
O serviço tem como objetivo fornecer todas as listagens da resolução de contratos de um terminado
ano/mês para uma determinada conta em formato PDF, devolvidos num ficheiro zip. Esta data pesquisada
corresponde à data de quando as listagens foram emitidas e não à data do conteúdo das mesmas e apenas
permite a pesquisa dos ultimos 6 meses à data atual.
Campos do Serviço
INPUT

vamos obter as
listagens.

listagens.

listagens.
OUTPUT
zipFile zipFile Binário Ficheiro zip com os PDF das

listagens.
3.12. WSDG012_PesquisarRemessas
Descrição
O serviço tem como objetivo devolver um ficheiro xml com as remessas para um período específico.
Campos do Serviço
INPUT

se pretende
pesquisar
remessas.
Deverá ser
preenchido com o
valor “TODAS”
caso não se
pretenda
especificar
apenas uma
conta.
DataInicio Data Início Char(10) Sim Data Início da AAAA-MM-DD

pesquisa. Exemplo: 2019-01-01
A preencher para
devolver dados
relativos a um
período
específico.
Não deverá ser

preenchido nas
chamadas em
que se utiliza
token.
DataFim Data Fim Char(10) Sim Data Fim AAAA-MM-DD

pesquisa. Exemplo: 2019-01-10
A preencher para
devolver dados
relativos a um
período
específico.
Não deverá ser

preenchido nas
chamadas em
que se utiliza
token.
valor devolvido
na última
chamada.
OUTPUT
Possíveis

baixo
mais uma chamada
(usando o token
devolvido)
estado da
ser utilizado para
obter os próximos
registos.
<Lista>
<Remessas>
<RemessaID>20211207_0008001</RemessaID>
<DataRemessa>2021-12-07</DataRemessa>
<TotalDocumentos>2</TotalDocumentos>
<TiposDocumentacao>
<Tipo>CP</Tipo>
<Existe>true</Existe>
</TiposDocumentacao>
<TiposDocumentacao>
<Tipo>CV</Tipo>
<Existe>false</Existe>
<TiposDocumentacao>
<Tipo>CPA</Tipo>
</Remessas>
<Remessas>
<TiposDocumentacao>
<Tipo>CP</Tipo>
<TiposDocumentacao>
<Tipo>CV</Tipo>
<TiposDocumentacao>
<Tipo>CPA</Tipo>
</Remessas>
<Remessas>
<TiposDocumentacao>
<Tipo>CP</Tipo>
<TiposDocumentacao>
<Tipo>CV</Tipo>
<TiposDocumentacao>
<Tipo>CPA</Tipo>
</Remessas>
</Lista>
A Tag Remessas é uma lista, ou seja, pode ser repetida várias vezes.
As Tags repetidas são listas (Remessas, TiposDocumentacao)
3.13. WSDG013_ConsultarRemessa
Descrição
O serviço tem como objetivo devolver um ficheiro xml com o detalhe de uma remessa específica.
Campos do Serviço
INPUT
RemessaID Identificador Char(16) Não Identificação da

da Remessa Remessa que se
pretende
consultar.
NrApolice Número da Char(16) Sim Número da

Apólice Apólice.
Se for preenchido
apenas devolve
os detalhes da
remessa dessa
apólice.
NrRecibo Número do Char(10) Sim Número do

Recibo Recibo.
Se for preenchido
apenas devolve
os detalhes da
remessa desse
recibo.
NIF Número de Char(20) Sim Número de

Contribuinte Contribuinte.
Se for preenchido
apenas devolve
os detalhes da
remessa desse
número de
contribuinte.

valor devolvido
na última
chamada.
OUTPUT
Possíveis

baixo
mais uma chamada
(usando o token
devolvido)
estado da
ser utilizado para
obter os próximos
registos.
<Lista>
<DetalheRemessa>
<Cliente>7100187118</Cliente>
<Nome></Nome>
<Apolice>8001926552</Apolice>
<TiposDocumentacao>
<Tipo>CP</Tipo>
<Impresso>NI</Impresso>
<TiposDocumentacao>
<Tipo>CV</Tipo>
<TiposDocumentacao>
<Tipo>CPA</Tipo>
</DetalheRemessa>
</Lista>
A Tag DetalheRemessa é uma lista, ou seja, pode ser repetida várias vezes.
As Tags repetidas são listas (DetalheRemessa, TiposDocumentacao)
3.14. WSDG014_ObterFicheiroRemessa
Descrição
O serviço tem como objetivo fornecer um documento de uma determinada remessa
Campos do Serviço
INPUT
RemessaID Identificador Char(16) Não Identificação da

da Remessa Remessa associada ao
documento que
pretendemos obter.
NrCliente Número de Char(10) Não Número de Cliente

cliente associado ao
documento que
pretendemos obter.

Apólice associado ao
documento que
pretendemos obter.
TipoDocumento Tipo do Char(03) Não Tipo do documento CV

Documento que pretendemos CRC
obter. CPA
CP
OUTPUT
4. Formato dos Dados

Os WebServices seguem as seguintes regras de formato de dados.
• Os valores com virgula vem sempre em formato 10.00, ou seja, com ponto.
• As datas têm sempre o formato AAAA-MM-DD
• As descrições dos campos têm como nome o nome do campo mais “Desc”
5. Ambientes
A Seguradoras Unidas disponibiliza dois ambientes para executar os WebServices:
TA – Testes de Aceitação
Será disponibilizado um conjunto de acessos e dados neste ambiente, de forma a ser possível testarem a
vossa aplicação.
PR - Produção
Este é o ambiente de produção, ou seja, o ambiente onde correm os nossos serviços.

A sigla su_webserver que tem sido utilizada na documentação refere-se ao servidor.
O servidor é diferente em TA e em PR.
6. Limites de execução
Os WebServices irão estar sujeitos a limites de execução a definir no futuro.
7. Questões Técnicas
WSDL
Em conjunto com este documento, foi-lhe entregue um ficheiro WSDL (SU_Digitizacao_V1.WSDL) com a
especificação dos WebServices.
Estrutura dos WebServices
Os WebServices disponibilizados seguem a seguinte estrutura.
Pedido
access_token Token da Sessão. Obtido através da do processo OAuth 2.0 de autenticação
<Nome do WS>In Estrutura com os dados funcionais de input do serviço
Resposta
Inteiro com o código de retorno do WS.
ReturnValue Valor Negativo corresponde a erro.
Neste caso é retornada unicamente a estrutura de erro. Valor 0 ou positivo
corresponde a sucesso. Neste caso é retornada unicamente a estrutura de sucesso.
Estrutura de Sucesso Estrutura com os dados funcionais de output do serviço
<Nome do WS>Out
Estrutura de erro.
Error
Code Código do erro no sistema onde ele ocorreu.
Description Descrição do erro.
Source Sistema onde o erro ocorreu
Type Enumerado (SYSTEM / BUSINESS)
SYSTEM – Erro de sistema
BUSINESS – Erro de utilizador
Ficheiro XML em formato Gzip
Os outputs dos serviços de listas devolvem um campo ficheiro, com um binário em formato gzip, por sua
vez este gzip tem um ficheiro XML. O ficheiro XML vai desta forma porque o formato XML tem um
potencial de compressão muito elevado.
O gzip pode ser descompactado em memória sem necessidade de escrever no disco.
Em Java pode ser utilizada a classe GZIPInputStream, em .NET será a classe GZipStream, em javascript
(Node.js) pode ser utilizado o modulo zlib.
Porque utilizamos SOAP o binário do campo ficheiro vai na rede em base64, no entanto este aspeto deverá
ser transparente para quem importa o WSDL.

Docs API Tranquilidade - Generali Seguros, S.A. - Digitização - Manual WebServices - V1 - 07

Enviado por

Dados do documento

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Docs API Tranquilidade - Generali Seguros, S.A. - Digitização - Manual WebServices - V1 - 07

Enviado por

Direitos autorais:

Formatos disponíveis

Generali Seguros

Responsável: Paulo Falcão

Sigla / acrónimo Significado Descrição

ID do Cliente e Segredo do Cliente

Esta forma de autenticação deve ser utilizada pelos utilizadores / agentes.

o Para aplicações nativas sem servidor verificar https://www.oauth.com/oauth2-

Mockup apenas para efeitos de ilustração

HTTP/1.1 302 Found

Em caso de erro serão devolvidos os parâmetros error e error_description ver

No segundo passo, será pedido um access_token utilizando o code previamente obtido.

A aplicação efetua um pedido HTTP GET ou POST com os seguintes parâmetros:

A resposta será um JSON com o formato definido no standart OAuth 2.0

O access_token devolvido terá uma validade de 12 horas.

O access_token será depois utilizado nos WebServices disponibilizados por SOAP.

Atenção - O access_token não pode ser utilizado usando o header Authorization.

Verificar o rfc6749 ( https://tools.ietf.org/html/rfc6749#section-5.2 )

O servidor su_webserver colocado no URL foi colocado apenas a título de exemplo.

Fluxo de autenticação "Refresh Token"

A aplicação efetua um pedido HTTP GET ou POST com os seguintes parâmetros:

A resposta será um JSON com o formato definido no standart OAuth 2.0

Verificar o rfc6749 ( https://tools.ietf.org/html/rfc6749#section-5.2 )

Fluxo de autenticação "Password Grant"

A aplicação efetua um pedido HTTP GET ou POST com os seguintes parâmetros:

A resposta será um JSON com o formato definido no standard OAuth 2.0

Verificar o rfc6749 ( https://tools.ietf.org/html/rfc6749#section-5.2 )

Verificar o rfc6749 ( https://tools.ietf.org/html/rfc6749#section-5.2 )

Os serviços têm 3 modos de funcionamento:

1 – Por ID especifico do Objecto (NrCliente / NrApolice / Nrinistro / NrRecibo)

2– Nenhum campo preenchido / Com SyncToken

RECOMENDADO - Este deve ser o modo preferencial para correr o serviço.

2.1 - Nenhum campo preenchido

2.2 - Com SyncToken

3– Por Datas (DataInicio e DataFim)

Apenas pode ser executado por utilizadores aplicacionais.

Campo WS Campo Tipo Opcional? Descrição Valores Possíveis

NrCliente Número de Char(10) Sim Referencia da entidade

DataInicio Data Inicio Char(10) Sim Data Inicio da AAAA-MM-DD

DataFim Data Fim Char(10) Sim Data Fim pesquisa AAAA-MM-DD

Campo WS Campo Tipo Descrição Valores Possíveis

Cliente Estrutura Contem informação

Cliente.Tipo Tipo de Cliente Char(01) Indica o tipo de

Cliente.TipoDesc Descrição de Char(60)

Cliente.EstadoCivil Estado Civil Char(01)

Cliente.EstadoCivilDesc Descrição de Char(60)

Cliente.NrIdentificacao Bilhete Entidade / Char(13) Número do Bilhete de

Cliente.Nacionalidade Nacionalidade Char(03)

Cliente.NacionalidadeD Descrição de Char(60)

Cliente.HabilitacoesLite Descrição de Char(60)

Cliente.Contactos[].Co Contato Char(16) Contato

Cliente.Emails[].TipoEma Tipo de Email Char(01) Tipo de email da

Cliente.Emails[].TipoEma Descrição do Char(60)

Cliente.CartaConducao Número Carta Char(10)

Cliente.CartaConducao Lista de Estruturas Array(Max 10) Informação da carta de

Cliente.CartaConducao Tipo de Carta Char(02)

Cliente.CartaConducao Descrição do Char(60)

Cliente.Sexo Sexo Char(01)

Cliente.SexoDesc Descrição do Char(60)

Cliente.NrEmpregados Número de Char(05) Número de empregados

Cliente.NrEmpregados Descrição Número Char(60)

Cliente.AnoInicioActivi Ano Início da Char(04)

Cliente.IndEntidadeVer Indicador de Char(03) Indica se entidade é SIM / NAO

Cliente.DataEntidadeV Data de Char(10) Data a partir da qual a

Ficheiro XML - Exemplo