WEBCAD MANUAL DO USUÁRIO - PRESTADOR DE SERVIÇOS DE TI -

Transcrição

1 SISTEMAS DE INFORMAÇÃO DO COMÉRCIO ELETRÔNICO WEBCAD MANUAL DO USUÁRIO - PRESTADOR DE SERVIÇOS DE TI - Versã WEBCAD Manual d Usuári Página 1 de 13

2 ÍNDICE 1. Intrduçã Mdel Operacinal Serviçs Síncrns Cntrle de Versã Web Service Dads de retrn de verificaçã da situaçã cadastral Regras de validaçã Tabela de Códigs de Retrn e Descrições de Mensagens Cntingência Ambientes de Hmlgaçã e de Prduçã Web Service Detalhes Técnics Serviç de Verificaçã da Situaçã Cadastral - WEBCAD Leiaute da Mensagem de Entrada Leiaute da Mensagem de Retrn Testand Web Service pr mei d sapui Dúvidas e errs mais freqüentes HTTP Errr SSL client certificate is required HTTP Errr 404 The resurce cannt be fund Códig de retrn 202 err n CNPJ bjet da verificaçã O e-cpf pde ser usad cm certificad digital para acess a WebCad? E e-cnpj? Pss utilizar e-cnpj da empresa? Pr que testar usand sapui? Referências WEBCAD Manual d Usuári Página 2 de 13

3 1. Intrduçã Este manual descreve funcinament d WEBCAD Serviç de Verificaçã de Situaçã Cadastral ds Cntribuintes d ICMS d Estad de Sã Paul. Este é um serviç via Web Service pel qual as empresas prestadras de serviçs de TI d segment de cmérci eletrônic pderã verificar a situaçã cadastral ativ u nã ds seus clientes, cntribuintes d Estad de Sã Paul, perante a Secretaria da Fazenda. O WEBCAD visa auxiliar às empresas n cumpriment de dispsitiv de verificaçã cadastral cnstante na legislaçã d Estad de Sã Paul, cm enfque na regulamentaçã feita pela Prtaria CAT156 de 24/09/2010. Este Web Service está publicad na página de referência ds Sistemas de Infrmaçã d Cmérci Eletrônic, dispnível n site da Secretaria de Fazenda d Estad de Sã Paul: 2. Mdel Operacinal A frma de prcessament das slicitações de serviçs para s Sistemas de Infrmaçã d Cmérci Eletrônic é síncrna. O serviç implementad até mment é, pis: Serviç Verificaçã situaçã cadastral de cntribuinte Implementaçã Síncrna 2.1 Serviçs Síncrns As slicitações de serviçs de implementaçã síncrna sã prcessadas imediatamente e resultad d prcessament é btid em uma única cnexã. A seguir, flux simplificad de funcinament: Passs executads n prcess cnsiderad ideal u flux básic : B1. O aplicativ d usuári inicia a cnexã enviand uma mensagem XML de slicitaçã de serviç para Web Service, cntend s parâmetrs para a verificaçã da situaçã cadastral: Dads d requisitante: CNPJ de verificaçã (1 pr vez). B2. O Web Service recebe a mensagem XML de slicitaçã de serviç e prcessa a verificaçã cadastral, de acrd cm s parâmetrs indicads. WEBCAD Manual d Usuári Página 3 de 13

4 B3. O Web Service devlve uma mensagem de resultad da verificaçã cadastral cntend as seguintes infrmações: CNPJ da empresa requisitante d Web Service (prestadr de serviçs de TI) CNPJ d estabeleciment d cntribuinte verificad Nme empresarial (razã scial) d estabeleciment d cntribuinte verificad Situaçã cadastral d cntribuinte => 1= ativ, 2= nã cadastrad u lcalizad u 0= qualquer utra diferente de ativ Data/hra da cnsulta a cadastr de cntribuintes de ICMS-SP (CADESP) Códig de retrn da mensagem referente a prcessament efetuad Descriçã da mensagem referente a prcessament efetuad B4. O aplicativ d usuári recebe a mensagem de resultad d prcessament e encerra a cnexã. 2.2 Cntrle de Versã A versã de referência deste Manual é a 1.1, dispnível a partir de 01/junh/2012. Qualquer mudança que cnste d leiaute das mensagens de XML serã cmunicadas às empresas através da página de referência ds Sistemas de Infrmaçã d Cmérci Eletrônic. 3. Web Service 3.1 Dads de retrn de verificaçã da situaçã cadastral Camp Obrigatriedade Origem / Descriçã CNPJ requisitante Sim CNPJ que identifica requisitante (empresa prestadra de serviçs de TI) d Web Service, cletad a partir d certificad digital da empresa, mdel A3. Data de Data e hra n servidr da aplicaçã quand Sim Prcessament fi recepcinad a mensagem XML Códig de retrn Códig referente a retrn da transaçã Sim (sucess u err) Descriçã da Mensagem referente a retrn da transaçã Sim mensagem de err (avis u err) CNPJ de verificaçã Sim CNPJ bjet da verificaçã cadastral Razã scial de verificaçã Nã Razã scial (nme empresarial) retrnad na verificaçã cadastral quand esta tiver sid executada Situaçã cadastral de Nã De acrd cm a verificaçã cadastral verificaçã Data e hra da verificaçã cadastral Nã efetuada quand esta tiver sid executada Data e hra em que fi efetuada a verificaçã cadastral d CNPJ válid n Cadastr de Cntribuintes de ICMS de SP WEBCAD Manual d Usuári Página 4 de 13

5 3.2 Regras de validaçã As regras de validaçã aplicada n Web Service sã as seguintes: Nº Descriçã 1 Validaçã d Certificad Digital utilizada n prtcl SSL (cnexã HTTPS) 2 Validaçã d Certificad Digital utilizada para assinatura da mensagem 3 Validaçã da mensagem XML 4 Validaçã d CNPJ d cntribuinte verificad 3.3 Tabela de Códigs de Retrn e Descrições de Mensagens CÓDIGO RESULTADO DO PROCESSAMENTO DA VERIFICAÇÃO CADASTRAL 200 Verificaçã cadastral prcessada cm sucess 201 A assinatura d XML de envi feita pel Requisitante nã é válida. Nã é pssível prcessar a verificaçã cadastral deste md. 202 O certificad digital utilizad para assinatura da mensagem está inválid. Pr favr, entre em cntat cm a Autridade Certificadra que emitiu certificad infrmand este prblema. 205 Arquiv XML enviad pel Requisitante d Webservice inválid u nã recebid. Verifique schema. 206 Arquiv XML enviad pel Requisitante d Web Service inválid u nã recebid 4. Cntingência Nã se prevêem situações de cntingência dignas de nta. Qualquer prblema na peraçã d serviç favr utilizar s cntats dispníveis na página de referência ds Sistemas de Infrmaçã d Cmérci Eletrônic: 5. Ambientes de Hmlgaçã e de Prduçã A SEFAZ-SP mantém dis ambientes para WEBCAD. O ambiente de hmlgaçã é específic para a realizaçã de testes, integraçã e adequaçã das aplicações d prestadr de serviçs de TI durante a fase de implementaçã d acess a WebService. O ambiente de prduçã é aquele que a empresa prestadra de serviçs deve utilizar ficialmente para as verificações cadastrais. Segue abaix endereç n ambiente de hmlgaçã para Web Service: Para ambiente de prduçã este é endereç de acess: WEBCAD Manual d Usuári Página 5 de 13

6 A utilizaçã pel prestadr de serviçs de TI de qualquer um ds dis ambientes prescinde de credenciament prévi feit pela SEFAZ-SP, cntud seu us será mnitrad e deve estar restrit a utilizaçã para fins de atendiment as pressupsts da Prtaria CAT 156, de Web Service Detalhes Técnics O Web Service dispnibiliza s serviçs que serã utilizads pels aplicativs das empresas prestadras de serviçs de TI para cumpriment d dispst na Prtaria CAT-156. de 24/09/2010. O mecanism de utilizaçã d Web Service segue as seguintes premissas: a) Fica dispnibilizad um Web Service para serviç de verificaçã cadastral, send verificad 1 (um) CNPJ pr requisiçã (envi de mensagem XML). b) O envi da slicitaçã e a btençã d retrn serã realizads na mesma cnexã através de um únic métd. c) A URL d Web Service está publicada na página de referência ds Sistemas de Infrmaçã d Cmérci Eletrônic, dispnível n prtal da Secretaria de Fazenda d Estad de Sã Paul: Acessand a URL pde ser btid WSDL (Web Services Descriptin Language) d Web Service. d) O prcess de utilizaçã d Web Service sempre é iniciad pel empresa REQUISITANTE enviand uma mensagem ns padrões XML e SOAP, através d prtcl SSL cm autenticaçã mútua. e) A crrência de qualquer err na validaçã ds dads recebids interrmpe prcess cm a dispnibilizaçã de uma mensagem cntend códig e a descriçã d err. 6.1 Serviç de Verificaçã da Situaçã Cadastral - WEBCAD O serviç de Verificaçã da Situaçã Cadastral é aquele ferecid pel Web Service denminad WEBCAD d Sistema de Infrmações d Cmérci Eletrônic. Verifica a situaçã cadastral de um cntribuinte que pertença a CADESP Cadastr de Cntribuintes de ICMS d Estad de Sã Paul. WEBCAD Manual d Usuári Página 6 de 13

7 6.1.1 Leiaute da Mensagem de Entrada Entrada: Exempl de estrutura XML a ser enviada pel Requisitante <sap:envelpe xmlns:sap=" xmlns:web=" <sap:header/> <sap:bdy> <web:xmlrequest> <webcad xmlns=" <dads_requisitante><cnpj_verificaca> </cnpj_verificaca></dads_requisitante> </webcad> </web:xmlrequest> </sap:bdy> </sap:envelpe> Os dads destacads em azul devem ser substituíds de acrd cm a situaçã particular d Requisitante. WEBCAD Manual d Usuári Página 7 de 13

8 6.1.2 Leiaute da Mensagem de Retrn Retrn: Exempl de estrutura XML cm a mensagem d resultad da transmissã. <sap:envelpe xmlns:sap=" xmlns:xsi=" xmlns:xsd=" <sap:header> <dads_retrn_header xmlns=" <cnpj_requisitante> </cnpj_requisitante> <data_prcessament>6/12/ :37:29</data_prcessament> <cd_retrn>200</cd_retrn> <ds_mensagem_err>verificaçã cadastral prcessada cm sucess</ds_mensagem_err> </dads_retrn_header> </sap:header> <sap:bdy> <VerificarSituacaCadastralCntribuinteResult xmlns=" <webcad> <dads_retrn> <cnpj_verificaca> </cnpj_verificaca> <raza_scial_verificaca>melhoramentos PAPEIS LTDA</raza_scial_verificaca> <situaca_cadastral_verificaca>1</situaca_cadastral_verificaca> <data_hra_verificaca>6/12/ :37:29</data_hra_verificaca> </dads_retrn> </webcad> </VerificarSituacaCadastralCntribuinteResult> </sap:bdy> </sap:envelpe> 7. Testand Web Service pr mei d sapui Instale sapui versã 3.5 (sapui-x32-3_5.exe). O instaladr (executável) se encntra n pacte Webcad_1-1_ zip dispnível na página de referência ds Sistemas de Infrmaçã d Cmérci Eletrônic. Esta aplicaçã também pde ser encntrada n site d fabricante cuja url para dwnlad [atualizad em 08/12/2010) é: (98,2MB) Uma vez instalad sapui, prsseguir cm a cnfiguraçã: WEBCAD Manual d Usuári Página 8 de 13

9 Selecine menu File, submenu Preferences. Selecine a pçã SSL Settings, clque caminh d seu certificad digital (exempl: sua_empresa.pfk ) em KeyStre e a senha em KeyStre Passwrd. Clique n btã Ok a final para salvar estas cnfigurações. WEBCAD Manual d Usuári Página 9 de 13

10 Selecine a pçã New SapUI Prject dentr d menu File. Dê um nme a prjet e adicine arquiv wsdl na pçã Initial WSDL/WADL. Vcê pde utilizar arquiv WebCadService.asmx também cntid n pacte Webcad_1-1_ zip. WEBCAD Manual d Usuári Página 10 de 13

11 8. Dúvidas e errs mais freqüentes 8.1 HTTP Errr SSL client certificate is required Originad pr um flux de err n qual servidr da aplicaçã WEBCAD nã cnfia n certificad d requisitante. Pde acntecer quand sistema requisitante tentar efetuar a cnexã usand um certificad cuj emissr, n cas, ICP-Brasil, nã está instalad na regiã de certificads cnfiáveis d servidr. Mensagem característica de retrn: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" " <HTML><HEAD><TITLE>The page requires a client certificate</title> <META HTTP-EQUIV="Cntent-Type" Cntent="text/html; charset=windws-1252"> <STYLE type="text/css"> BODY { fnt: 8pt/12pt verdana } H1 { fnt: 13pt/15pt verdana } H2 { fnt: 8pt/12pt verdana } A:link { clr: red } A:visited { clr: marn } </STYLE> </HEAD><BODY><TABLE width=500 brder=0 cellspacing=10><tr><td> <h1>the page requires a client certificate</h1> The page yu are attempting t access requires yur brwser t have a Secure Sckets Layer (SSL) client certificate that the Web server will recgnize. The client certificate is used fr identifying yu as a valid user f the resurce. <hr> <p>please try the fllwing:</p> <ul> <li>cntact the Web site administratr if yu believe yu shuld be able t view this directry r page withut a client certificate, r t btain a client certificate.</li> <li>if yu already have a client certificate, use yur Web brwser's security features t ensure that yur client certificate is installed prperly. (Sme Web brwsers refer t client certificates as brwser r persnal certificates.)</li> </ul> <h2>http Errr Frbidden: SSL client certificate is required.<br>internet Infrmatin Services (IIS)</h2> <hr> WEBCAD Manual d Usuári Página 11 de 13

12 <p>technical Infrmatin (fr supprt persnnel)</p> <ul> <li>g t <a href=" Prduct Supprt Services</a> and perfrm a title search fr the wrds <b>http</b> and <b>403</b>.</li> <li>open <b>iis Help</b>, which is accessible in IIS Manager (inetmgr), and search fr tpics titled <b>abut Certificates</b>, <b>using Certificate Trust Lists</b>, <b>enabling Client Certificates</b>, and <b>abut Custm Errr Messages</b>.</li> </ul> </TD></TR></TABLE></BODY></HTML> 8.2 HTTP Errr 404 The resurce cannt be fund Originad pr um flux de err n qual endereç d servidr da aplicaçã WEBCAD fi errneamente digitad u infrmad. Verifique seu arquiv WSDL (.asmx ). Mensagem característica de retrn: <html> <head> <title>the resurce cannt be fund.</title> <style> bdy {fnt-family:"verdana";fnt-weight:nrmal;fnt-size:.7em;clr:black;} p {fnt-family:"verdana";fnt-weight:nrmal;clr:black;margin-tp: -5px} b {fnt-family:"verdana";fnt-weight:bld;clr:black;margin-tp: -5px} H1 { fnt-family:"verdana";fnt-weight:nrmal;fnt-size:18pt;clr:red } H2 { fnt-family:"verdana";fnt-weight:nrmal;fnt-size:14pt;clr:marn } pre {fnt-family:"lucida Cnsle";fnt-size:.9em}.marker {fnt-weight: bld; clr: black;text-decratin: nne;}.versin {clr: gray;}.errr {margin-bttm: 10px;}.expandable { text-decratin:underline; fnt-weight:bld; clr:navy; cursr:hand; } </style> </head> <bdy bgclr="white"> <span><h1>server Errr in '/' Applicatin.<hr width=100% size=1 clr=silver></h1> <h2> <i>the resurce cannt be fund.</i> </h2></span> <fnt face="arial, Helvetica, Geneva, SunSans-Regular, sans-serif "> <b> Descriptin: </b>http 404. The resurce yu are lking fr (r ne f its dependencies) culd have been remved, had its name changed, r is temprarily unavailable. Please review the fllwing URL and make sure that it is spelled crrectly. <br><br> </bdy> </html> <b> Requested Url: </b>/webcadservice/webcadservice.asmx<br><br> 8.3 Códig de retrn 202 err n CNPJ bjet da verificaçã Originad pr um flux de err quand a mensagem XML d requisitante infrmar um CNPJ que nã tenha validade em nível de dígit verificadr. Observe que cas valr nã cntenha s 14 dígits exigids (nã sã permitidas letras nem caracteres especiais, tip / -.) a mensagem retrnada será crrespndente a códig de err 205. Mensagem característica de retrn: <sap:envelpe xmlns:sap=" xmlns:xsi=" xmlns:xsd=" <sap:header> <dads_retrn_header xmlns=" <data_prcessament>21/12/ :32:53</data_prcessament> <cd_retrn>202</cd_retrn> <ds_mensagem_err>o CNPJ pesquisad nã é válid.</ds_mensagem_err> </dads_retrn_header> </sap:header> <sap:bdy/> </sap:envelpe> WEBCAD Manual d Usuári Página 12 de 13

13 8.4 O e-cpf pde ser usad cm certificad digital para acess a WebCad? E e-cnpj? O certificad digital a ser utilizad deverá ser de pessa jurídica, d tip A3. O e-cpf nã pde ser utilizad para WEBCAD; pde utilizar e-cnpj u e-pj. 8.5 Pss utilizar e-cnpj da empresa? O e-cnpj é um certificad digital que atende s padrões técnics d prjet, nã existind qualquer impediment técnic para seu us n WEBCAD. Cntud, us d e-cnpj só é recmendad para empresas que fazem uma pequena quantidade de verificaçã cadastral diária, pis certificad digital e-cnpj é utilizad em utras atividades da empresa que exigem certificad digital cm é cas ds serviçs eletrônics da Receita Federal d Brasil. Assim, a empresa prestadra de serviçs deve avaliar a pssibilidade de adquirir um certificad digital de PJ, d tip PJ-Múltipl, vltad para us d WEBCAD. 8.6 Pr que testar usand sapui? O sapui é adequad para testar métds Web Service pis nele pde ser acplad qualquer certificad digital (cntant que certificad tenha capacidade de exprtar a parte privada dele). Assim, antes que aplicativ d prestadr de serviçs de TI seja cnstruíd e use certificad ficial da empresa pde ser simulada a chamada a WEBCAD e crrespndente retrn frnecid pela SEFAZ-SP a fim de que se demnstre a dispnibilidade d serviç e se valide as estruturas das mensagens XML de request (inclusive cm assinatura) e respnse. 9. Referências Prtaria CAT-156, 24/09/2010 WEBCAD Manual d Usuári Página 13 de 13