Tecnologia: Área: CDC. Versão: 1.0

Transcrição

1 Manual de Integração Tecnologia: WebServices SOAP XML Área: CDC Produto: Administração Versão: 1.0 Autor: Angelo Bestetti Junior

2 Conteúdo Introdução... 3 Considerações Iniciais... 4 Privacidade... 5 WebServices SOAP/XML... 6 Modelo Operacional... 7 WebServices EndPoints... 8 Saldo Requisição SOAP/XMLL Saldo Resposta SOAP/XML Estrutura de Dados: PessoaFísicaEstendida Extrato Requisição SOAP/XML Extrato Resposta SOAP/XMLL Estrutura de Dados: Extrato Transações Disponíveis Arquitetura de Comunicação Literatura sobre WebServicess Ferramentas paraa WebServices... 18

3 Introdução Este documento tem por objetivo a definição das especificações e critérios técnicos necessários para integração entre os sistemas de informações das empresas e o Portal do SOAWebServices. Este documento é especifico para a transações de Saldo e Extrato

4 Considerações Iniciais Para um bom entendimento deste manual é requerida alguma experiência emm desenvolvimentoo de aplicações Web. Conceitos de protocolos, transações, conexões de dados podem ou serão abordadas neste documento.

5 Privacidade As informações contidas nesse documento, incluindo as URLs e outras referências de website, são passíveis de mudança sem aviso prévio. A menos que haja nota específica, as companhias de exemplo, organizações, produtos, nomes de domínio, endereços de e mail, logos, pessoas, lugares e eventos são fictícioss e não têm nenhuma associação comm alguma ambiente real. Estar de acordo com todas ass leis aplicáveis de copyright é de responsabilidade do usuário. Não limitando os direitos sob o copyright,, nenhuma parte deste documento d pode ser reproduzida, armazenada, recuperada através de sistemas de leitura, transmitida por qualquer forma ou por qualquer meio (eletrônico, mecânico, fotocópia, gravação ou outros), ou para qualquer propósito sem a expressa permissão por escrito da i Stream Realtime Business. A i Stream Realtime Businesss pode ter patentes, marcas, direitoss autorais ou outros direitos de propriedade intelectual em relação aoo objeto principal deste documento. d Exceto caso expressamente descrito em qualquer termo de licença de uso da i Stream Realtime Business, o fornecimento deste documento não lhee oferece nenhuma licença sobre essas patentes,, marcas, direitos autorais, ou outra propriedade intelectual.

6 WebServices SOAP/XML Webservice é uma solução utilizada na integração de sistemas e na n comunicação entre aplicações diferentes. Com esta tecnologia é possível que novas aplicações a possam interagir com aquelas que já existem e que sistemas desenvolvidos em plataformas diferentes sejam compatíveis. Os Webservices são componentes que permitem às aplicações enviar e receber dados em formato XML. Cadaa aplicação pode ter a sua própria "linguagem", que é traduzida para uma linguagem universal, o formatoo XML. Para as empresas, os Webservices podem trazer agilidade para oss processos e eficiência na comunicação entre cadeias de produção ou de logística. Toda e qualquer comunicação entre sistemas passa a ser dinâmica e principalmente segura, pois não há h intervenção humana. As basess para a construção de um Webservice são os padrões XML e SOAP. O transporte doss dados é realizado normalmente via protocolo HTTP (o padrão nãoo determina o protocolo de transporte). Os dados são transferidos noo formato XML, encapsulados pelo protocolo SOAP. Uma vantagem a destacar é que no pontoo de venda não é necessário instalar nenhum software para realizar a comunicação (autorizadores, por exemplo), pois, a automação comercial acessa diretamentee os nossos servidores. O que é WSDL Web Service Definition Language define um sistema para a descrição de serviços. Através dela, descrevemos os serviços externos, ou interfaces que são oferecidos por uma determinadaa aplicação, independente de sua plataforma ou linguagem de programação. O seu principal objetivo é descrever as interfaces apresentadas e apontar a localização dos seus serviços. Por ser um documento XML, sua leitura se torna fácil e acessível.

7 Modelo Operacional Nossoo portal consiste em um hub de serviços próprios e agregados que disponibilizam para sua infraestrutura de informações a maior gama de soluções em diversas áreas. Áreas atendidas: Informações financeiras Serasa Experian CDC Confirmação de Dados Cadastrais Sintegra Imposto de Renda CEP Boletos Bancários Geo Informações Cotações de Moedas Telefonia

8 WebServices EndPoints Endpoint (URL) de Produção: : // com.br/webservices/producao/sws/ /administracao.asmx WSDL de Produção: // com.br/webservices/producao/sws/ /administracao.asmx?wsdl

9 Saldo Requisição SOAP/XML 1..2 POST /webservices/producao/sws/administracao.asmxx HTTP/1.11 Host: Content-Type: application/soap+ +xml; charset=utf-88 Content-Length: length?xml version="1.0" encoding="utf-8"?> soap12:envelope xmlns:xsi=" xmlns:xsd=" w3.org/2001/xmlschema" xmlns:soap12= =" /soap-envelope"> soap12:body> Saldo xmlns="soawebservices"> Credenciais> >string / > Senha>string /Senha> /Credenciais> /Saldo> / /soap12:body> /soap12:envelope>

10 Saldo Resposta SOAP/XML 1.2 HTTP/ OK Content-Type: application/soap+ +xml; charset=utf-88 Content-Length: length?xml version="1.0" encoding="utf-8"?> soap12:envelope xmlns:xsi=" xmlns:xsd=" w3.org/2001/xmlschema" xmlns:soap12= =" /soap-envelope"> soap12:body> SaldoResponse xmlns="soawebservices"> SaldoResult> Saldo>Decimal/Saldo> Mensagem>string/Mensagem> Status>boolean/Status> /SaldoResult> /SaldoResponse> / /soap12:body> /soap12:envelope>

11 Estrutura de Dados: Saldo Estrutura de Dados Item Tipo Decimal Nome Saldo Varchar(max) Mensagem Boolean Status Descrição Saldo atual de seu s contrato. Este campo é formatado com 4 casas decimais. Mensagem do Sistema S para a transação Status da Transacao ATENÇÃO: Comoo informado acima no campo de número 3, o campo status retorna r verdadeiro (true) no caso da transação ser realizada com sucesso, caso contrário irá retornar comoo Falso (false). O Status de Falso normalmente é retornado em caso de falhas de comunicação, dígitos verificadores errados, saldo insuficiente para contas Pré Pagas etc etc.

12 Extrato Requisição SOAP/XML 1.2 POST /webservices/producao/sws/administracao.asmxx HTTP/1.11 Host: Content-Type: application/soap+ +xml; charset=utf-88 Content-Length: length?xml version="1.0" encoding="utf-8"?> soap12:envelope xmlns:xsi=" xmlns:xsd=" w3.org/2001/xmlschema" xmlns:soap12= =" /soap-envelope"> soap12:body> Extrato xmlns="soawebservices"> Credenciais> >string / > Senha>string /Senha> /Credenciais> Mes>string/Mes> Ano>string/Ano> /Extrato> / /soap12:body> /soap12:envelope>

13 Extr HTTP Cont Cont?xm soa xmln xmln s / /so rato Resp P/ tent-type: tent-lengt ml version ap12:envel ns:xsd="ht ns:soap12= soap12:bod ExtratoR Extrat Prod Pr /P Pr /P /Pro Sald Mens Stat /Extra /Extrato /soap12:bo oap12:enve posta SOA OK applicat th: length n="1.0" en lope xmlns ttp://www. =" dy> Response x toresult> dutos> roduto> Produto>s Mes>strin Ano>strin Quantidad Consumo>d Produto> roduto> Produto>s Mes>strin Ano>strin Quantidad Consumo>d Produto> odutos> do>decimal sagem>stri tus>boolea atoresult> oresponse> ody> elope> AP/XML 1 tion/soap+ h ncoding="u s:xsi="htt w3.org/20 xmlns="soa string/pr ng/mes> ng/ano> de>int/qu decimal/c string/pr ng/mes> ng/ano> de>int/qu decimal/c l/saldo> ing/mensa an/status > >.2 +xml; char utf-8"?> tp:// 001/XMLSch g/2003/05/ AWebServic roduto> uantidade> Consumo> roduto> uantidade> Consumo> agem> s> rset=utf-8 w3.org/200 hema" /soap-enve ces"> > > 8 01/XMLSche elope"> ema-instance"

14 Estrutura de Dados: Extrato Estrutura de Dados Item Tipo Node Produtos P Node Produto P Varchar(100) Produto P Varchar(2) Mes Varchar(4) Ano Integer Quantidade Decimal Consumo C Decimal Nome Saldo Varchar(max) Mensagem Descrição Node XML com lista de Produtos consumidoss Node XML com Produto consumido Nome do Produto Mês do Comsumo Ano do Consumo Quantidade de transações consumidas Valor Total do acumulo a das faixas de consumo totalizando em valores reais o consumo no periodo. Este campo é formatado com 4 casas decimais. Saldo atual do contrato. c Este campo é formatado com 4 casas decimais. Mensagem do Sistema S para a transação 10 Boolean Status Status da Transacao ATENÇÃO: Comoo informado acima no campo de número 10, o campo statuss retorna verdadeiro (true) no caso da transação ser realizada com sucesso, caso contrário irá retornar comoo Falso (false). O Status de Falso normalmente é retornado em caso de falhas de comunicação, dígitos verificadores errados, saldo insuficiente para contas Pré Pagas etc etc.

15 Transações Disponíveiss Ambiente de Produção: Extrato Consulta Saldo Consulta Extrato de sua Conta Saldo de sua Conta

16 Arquitetura de Comunicação Um exemplo de preenchimento em ASP..NET (VB) para a transação de Saldo abaixo: ' Lembre se de importar a Service Reference e usar o nome n svcsws Public Sub ConsultaSaldo( ) ' Declara o Servico que vai ser usado Dim owebservices As New svcsws.administracao ' Declara o Objeto que contemm as credenciais de Acesso A Dim Credenciais As New svcsws.credenciais ' Declara o Objeto que ira retornar os dados, notem que comoo o ' objetoo de servico tem o nome de Saldo e o objeto de retorno tambem ' se chama Saldo o Visual Studio alteraa o nome para Saldo1 Dim Retorno As New svcsws.saldo ' Preenche com sua credenciais o objeto "Credenciais" Credenciais. = "seu " Credenciais.Senha = "sua senha" Try ' Faz se a chamada do Servico passando os parametros credenciais ' e o CEP desejado e retornaa os valores no objeto Retorno Retorno = owebservices.saldo(credenciais) Catch ex As Exception ' Tratamento de Erro End Try End Sub

17 Literatura sobre WebServices br/autor/575/angelo bestetti web_services_em_php_com_nusoap/

18 Ferramentas para WebServices SOAP UI (Recomendado) // Microsoft Visual Studio // br/