Você está na página 1de 7

IPIRANGA PRODUTOS DE PETRÓLEO

Construção do Serviço
IPG Clientes Portal

Versão 1.0
IPG Clientes Portal
Especificação de Serviço
Versão: 1.0

HISTÓRICO DE REVISÕES

DATA VERSÃO DESCRIÇÃO AUTOR

24 / 09 / 2018 1.0 Documentação Inicial Matheus Ribas

CONFIDENCIAL IPIRANGA PRODUTOS DE PETRÓLEO. II


IPG Clientes Portal
Especificação de Serviço
Versão: 1.0

ÍNDICE

1. Objetivo 1

2. Campo de Aplicação 1

3. Serviço 1
3.1 Descrição do Serviço 1
3.2 Direito de Acesso 1
3.3 Protocolo do Serviço 1
3.4 URL do Serviço 2

4. Capacidades 2

4.1 Descrição 2

4.2 Posicionamento da Capacidade 2


4.2.1 Razão Funcional 2
4.2.2 Regras de Negócio Atendidas 2

4.3 Técnico 3
4.3.1 Buscar Dados Cliente Siebel 3

5. Referências 4

CONFIDENCIAL IPIRANGA PRODUTOS DE PETRÓLEO. III


IPG Clientes Portal
Especificação de Serviço
Versão: 1.0

ESPECIFICAÇÃO DE SERVIÇO
1. Objetivo
Este documento descreve o serviço corporativo em termos de envolvimento, fornecendo restrições
técnicas e de negócio, bem como informações de requisitos e semânticas para uso deste serviço.

2. Campo de Aplicação
Governança de Serviços

3. Serviço

3.1 Descrição do Serviço


Desenvolver uma integração para consultar os dados cadastrais de clientes do Mercado
Empresarial, no SIEBEL pelo Ensemble.
Nome do serviço: “buscarDadosClienteSiebel”

3.2 Direito de Acesso


Interno

3.3 Protocolo do Serviço


Para acesso externo (para consumidores fora da rede Ipiranga):
- é utilizado o protocolo HTTPS com autenticação WS-Security (somente autenticação)
- ter usuário com permissão de uso das capacidades.
Para acesso interno:
- é utilizado o protocolo HTTP com autenticação WS-Security (somente autenticação)
- ter usuário com permissão de uso das capacidades.

Exemplo de mensagem SOAP enviando informações de usuário de senha conforme o padrão


UsernameToken da especificação WS-Security:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:s="http://www.w3.org/2001/XMLSchema" xmlns:wsse="http://docs.oasis-
open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-
1.0.xsd">
<SOAP-ENV:Header>
<Security xmlns="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-secext-1.0.xsd">
<UsernameToken>
<Username>USUÁRIO</Username>
<Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
username-token-profile-1.0#PasswordText">SENHA</Password>
</UsernameToken>
</Security>
</SOAP-ENV:Header>
<SOAP-ENV:Body>

CONFIDENCIAL IPIRANGA PRODUTOS DE PETRÓLEO 1


IPG Clientes Portal
Especificação de Serviço
Versão: 1.0

3.4 URL do Serviço

Desenvolvimento
Interno:
http://ensemdes:7070/csp/ipiranga/ws.ipp.buscarDadosClienteSiebel.Service.CLS

Homologação
Interno:
http://ensemhom:2010/csp/ipiranga/ws.ipp.buscarDadosClienteSiebel.Service.CLS

Produção
Interno: http://eaiprd:2010/csp/ipiranga/ws.ipp.buscarDadosClienteSiebel.Service.CLS

Externo:
Não se aplica.

4. Capacidades

4.1 Descrição

Capacidade Descrição
1 buscarDadosClienteSiebel Recupera dados do cliente para o Mercado Empresarial

4.2 Posicionamento da Capacidade

4.2.1 Razão Funcional

4.2.1.1 buscarDadosClienteSiebel
Retorna os dados do cliente a partir do seu nome (razão social).

4.2.2 Regras de Negócio Atendidas

4.2.2.1 buscarDadosClienteSiebel
Não se aplica

CONFIDENCIAL IPIRANGA PRODUTOS DE PETRÓLEO 2


IPG Clientes Portal
Especificação de Serviço
Versão: 1.0

4.3 Técnico

4.3.1 buscarDadosClienteSiebel

4.3.1.1 Parâmetros de Entrada (Request)

buscarDadosClienteSiebel_Input
Obrigatório
Campo Descrição (exemplo) Tipo Tam. Formato
S/N?
Object_spcId Identificação do cliente String N
Identificação do cliente.
_XMLIn As informações de pesquisa serão passadas em String N
XML neste campo.

4.3.1.2 Parâmetros de Saída (Response) Dados do Cliente - _XMLOut

Account
Obrigatório
Campo Descrição (exemplo) Tipo Tam. Formato
S/N?
AccountStatus Status da conta (ex: ATIVO) String S
Alias Razão Social do cliente (ex: A P SENNA LTDA) String N
Name CNPJ (ex: 02575190000109) String S
CSN Código do cliente (ex: 48003) String N
IPGCodGV Código da gerência de vendas (ex: 70806) String N
IPGCodZV Código da zona de vendas (ex:515103) String N
Location cdPtov - 14943 String N
AccountNumber Número da conta (ex: 480037) String N
CUTLastName Nome da pessoa de contato String N
IPGContactFax Fax (DDD + numero) – (ex: 2124315112) String N
IPGContactTelefone Telefone (DDD + numero) – (ex: 2124314438) String N
PrimaryContactId Chave para atualização do contato – (ex:1-13VMV) String N
GerenciaDeVenda (ex: G.V. URBANO RIO DE
IPGDescGV N
JANEIRO) String
IPGDescZV AssessorComercial (ex:RAFAEL MARQUES) String N
EmailAddress EmailAddress String N
IPGEmailAlternativo Email alternativo (obs: não está utilizando) String N
IPGTelefoneAlternativo Telefone alteranativo (DDD + numero) String N
ListOfServiceAgreement Lista com a estrutura Service Agreement Lista N
ListOfAffiliatedAccount Lista com a estrutura Affiliated Account Lista N

Service Agreement
Obrigatório
Campo Descrição (exemplo) Tipo Tam. Formato
S/N?
AgreementEndDate String N
AgreementNumber String N
AgreementStartDate String N
AgreementStatus String S
IPGCondSeguro String N
IPGNomeSeguradora String N
IPGNumApolice String N
IPGPendencia String N
IPGSituacaoApolice String N

CONFIDENCIAL IPIRANGA PRODUTOS DE PETRÓLEO 3


IPG Clientes Portal
Especificação de Serviço
Versão: 1.0

Affiliated Account
Obrigatório
Campo Descrição (exemplo) Tipo Tam. Formato
S/N?
Alias Nome fantasia (ex: AUDEN REFRIGERAÇÃO LTDA) String N
IPGTipoManutencao Tipo de manutenção (ex: AMPM - CAMARA FRIA) String N
Name Nome (ex: 93928000168) String N
PartyId Código (ex:1-2959B) String N

4.3.1.3 Parâmetros de Saída (Response Genérico)

Resposta (status integração)


Obrigatório
Campo Descrição (exemplo) Tipo Tam. Formato
S/N?
Status Status de execução do serviço (0 Boolean 1
Mensagem Descrição da mensagem de erro String 512

4.3.1.4 Pré-Condição
O usuário para autenticar deve ser de um assessor.

4.3.1.5 Pós-Condição
Não se aplica.

4.3.1.6 Exemplo de Requisição


Não se aplica.

5. Referências
Não se aplica.

CONFIDENCIAL IPIRANGA PRODUTOS DE PETRÓLEO 4