Manual Utilizacao WebService

NOTA FISCAL DE SERVIO ELETRNICA (NFS-e)

Manual de Utilizao WebService

Verso 1.9

Nota Fiscal de Servio Eletrnica NFS-E

Manual de Utilizao WebService Pgina 2 de 31

SUMRIO

SUMRIO ...................................................................................................................................... 2

1. INTRODUO ..................................................................................................................... 3

2. CRIANDO UM CERTIFICADO DIGITAL ............................................................................. 3

2.1. ATUALIZANDO O CERTIFICADO RAIZ DO COMPUTADOR DE ONDE PARTIR A REQUISIO PARA O WEBSERVICE ............................................................................................................................... 6

3. VINCULANDO UM CERTIFICADO DIGITAL A UM USURIO DO ISS CURITIBA ........ 12

3.1. AMBIENTE PILOTO ............................................................................................................ 13 3.2. AMBIENTE DE PRODUO ................................................................................................. 14

4. EXPORTANDO O CERTIFICADO PARA UM ARQUIVO ................................................. 16

5. INTERFACES DISPONVEIS NO WEBSERVICE ............................................................. 22

5.1. RECEPO DE LOTE DE RPS ............................................................................................ 22 5.2. CONSULTA A SITUAO DE LOTE DE RPS .......................................................................... 23 5.3. CONSULTA DE LOTE DE RPS ............................................................................................ 23 5.4. CONSULTA NOTA FISCAL DE SERVIOS ELETRNICA POR RPS ......................................... 23 5.5. CONSULTA NOTA FISCAL DE SERVIOS ELETRNICA......................................................... 23 5.6. VALIDAO BSICA DO LOTE DE RPS ................................................................................. 23 5.7. CANCELAMENTO DE LOTE DE NFS-E ................................................................................. 23 5.8. CANCELAMENTO DE LOTE DE RPS .................................................................................... 24

6. PADRES TCNICOS ...................................................................................................... 24

6.1. PADRO DE CERTIFICADO DIGITAL .................................................................................... 24 6.2. ASSINATURA EM UM LOTE DE RPS...................................................................................... 24

6.2.1. Assinando um lote de rps .................................................................................. 24 6.3. SCHEMAS XML ................................................................................................................ 28

7. WEBSERVICE NFS-E ........................................................................................................ 28

7.1. WSDL ............................................................................................................................. 28 7.2. TIPOS UTILIZADOS ............................................................................................................ 29 7.3. REALIZANDO UMA CHAMADA A UM MTODO DO WEBSERVICE ............................................. 29 7.4. REALIZANDO A VALIDAO BSICA DO ARQUIVO DE LOTE DE RPS ....................................... 29

8. ARQUIVOS DE EXEMPLO ................................................................................................ 30

9. RESUMO LINKS ................................................................................................................ 30



1. Introduo

Este manual tem por objetivo explicar como criar e utilizar um certificado digital em ambiente

piloto, a fim de realizar os testes com o WebService. Tambm tem como objetivo auxiliar na

configurao do ambiente para realizar as operaes em ambiente de produo.

2. Criando um certificado digital

Para dar incio a criao do certificado digital (em ambiente piloto) deve-se:

Caso a verso do navegador Internet Explorer utilizado seja inferior a 10, utilizar o endereo:

http://pilotoisscuritiba.curitiba.pr.gov.br:8080/certsrv/

Caso a verso do navegador Internet Explorer utilizado seja igual ou superior a 10, utilizar o

endereo:

https://pilotoisscuritiba.curitiba.pr.gov.br:8081/certsrv/

Observao: caso o navegador utilizado seja diferente do Internet Explorer, recomenda-se utilizar o link

acima.

Tal endereo ir apresentar a seguinte tela:

Para criarmos o nosso certificado de testes clique em (Request a certificate).

Clicando no link referido acima o sistema ir apresentar a seguinte tela:



Neste passo necessitamos criar um certificado de browser, ou seja, clique no link (Web

Browser Certificate).

Alguns dados pessoais sero solicitados como mostrado abaixo:

Para que possamos criar um certificado vlido (em ambiente piloto) necessrio clicar no link

(More Options >>), aps selecionado ser apresentada a seguinte tela:

Aps o carregamento da pgina mostrada acima deveremos clicar no link (use the Advanced

Certificate Request form), pois necessitamos marcar uma opo para tornar a chave pblica

exportvel.

Aps clicar no link referido acima ser apresentada a seguinte tela:



Preencha os dados do formulrio mostrado acima.

Selecione a opo (Mark Keys as exportable), como mostrado abaixo.

Deixe apenas a opo (Mark Keys as exportable) selecionada a opo (Export Keys to

file) no dever ser marcada.

Aps os dados serem preenchidos clique no boto (submit). Ir aparecer uma tela de

confirmao conforma mostrado abaixo:



Aps confirmar a solicitao do certificado, ir aparecer uma tela para que possamos instalar o

certificado digital em nossa mquina, como mostrado a seguir:

Clicando no link (Install this certificate) ir aparecer a seguinte tela de confirmao:

Confirmando a instalao de nosso certificado digital ir aparecer a seguinte tela:

Pronto agora temos um certificado digital (vlido em ambiente piloto), mas ainda necessrio

vincular o mesmo ao nosso usurio do sistema ISS Curitiba para que o sistema reconhea o

mesmo (Conforme mostrado no Tpico 3 deste manual), mas antes vamos atualizar o

certificado raiz do computador que far as requisies para o WebService do ambiente piloto

para que no ocorra erro na requisio da origem para o destino (WebService).

2.1. Atualizando o certificado raiz do computador de onde partir a requisio para o WebService

Para que a requisio para o WebService seja aceita, necessrio atualizar o certificado raiz do computador de onde partir a mesma (seu servidor local). Para tanto, basta executar os seguintes passos no Windows:



Primeiro executar o Microsoft Management Console:

Na tela que ser exibida, selecionar menu Arquivo -> Adicionar/remover snap-in...

* Na janela Adicionar/remover snap-in, clicar no boto Adicionar...



* Na janela Adicionar snap-in autnomo, selecionar Certificados e clicar em Adicionar

*Deixar selecionada a opo Minha conta de usurio e clicar em Concluir



*A janela Adicionar/remover snap-in estar atualizada, basta clicar OK

*A janela do MMC estar com o seguinte aspecto

*Agora abaixo da pasta Autoridades de certificao raiz confiveis clicar o boto direito do mouse na sub-pasta Certificados, selecionar a opo Todas as tarefas -> Importar



*Na tela do assistente de importao clicar em Avanar

*Faa o download do certificado raiz a partir do link do portal Boa Nota Fiscal: http://isscuritiba.curitiba.pr.gov.br/portalnfse/manuais.aspx * Acessar os Itens: CERTIFICADO RAZ - SERVIDOR PILOTO - 08/01/2013 CADEIA DE CERTIFICAO - SERVIDOR PILOTO - 08/01/2013 * Salvar os arquivos raizPiloto.zip e certnew_piloto_renew.zip localmente, e extrair os contedos raizPiloto.cer e certnew_piloto_renew.p7b ->Realizar o procedimento a seguir para os dois arquivos extrados *Agora selecione o arquivo extrado raizPiloto.cer clicando no boto Procurar e depois em Avanar



*Clicar em Avanar (sem alteraes na tela)

* Clicar em Concluir



*Na tela de aviso confirmar clicando em SIM

Depois, repetir o mesmo processo para o arquivo extrado certnew_piloto_renew.p7b

Pronto agora temos um certificado digital (vlido em ambiente piloto), mas ainda necessrio

vincular o mesmo ao nosso usurio do sistema ISS Curitiba para que o sistema reconhea o

mesmo. (Conforme mostrado no Tpico 3 deste manual).

3. Vinculando um Certificado Digital a um usurio do ISS Curitiba



3.1. Ambiente piloto Aps realizarmos todos os passos descritos anteriormente precisamos vincular o certificado

digital recm criado ao nosso usurio do ISS Curitiba.

Para isso devemos entrar no ISS Curitiba em ambiente (piloto) utilizando HTTPS, ou seja,

utilizando um canal seguro de comunicao, importante ressaltar que a conexo dever

utilizar https, caso contrrio o certificado digital no ser reconhecido pelo servidor.

https://pilotoisscuritiba.curitiba.pr.gov.br/iss/

Ao carregar o endereo acima no navegador, dever aparecer uma caixa de dilogo, conforme

figura abaixo:

Na caixa de dilogo acima iro aparecer todos os certificados digitais vlidos para nossa

entidade certificadora (para ambiente piloto).

Selecione o certificado digital desejado e clique em OK.

Aps selecionar o certificado digital entre no ISS Curitiba utilizando o usurio e senha de

acesso ao mesmo.

IMPORTANTE: Para acesso ao ambiente Piloto, deve-se usar o usurio j utilizado no

sistema ISS Curitiba com a senha = 123456 .

Uma vez logado no sistema, entre no menu Contribuinte -> Certificado Digital -> Vincular

Ir aparecer uma tela de confirmao perguntando se voc realmente deseja vincular seu

certificado digital ao seu usurio do ISS Curitiba, como mostrado na figura abaixo:



Confirme a vinculao clicando em (Sim). Feito isso ir aparecer uma tela confirmando a

vinculao do certificado, como descrito abaixo:

Depois de realizados tais passos j podemos utilizar o WebService para a empresa a qual o

usurio pertence, pois j existe um certificado digital vinculado.

3.2. Ambiente de Produo Para realizarmos a vinculao do certificado digital do usurio em ambiente de produo deveremos acessar o endereo https://isscuritiba.curitiba.pr.gov.br/iss. Ao entrar no endereo citado acima ir aparecer uma caixa de dilogo como a mostrada abaixo.



Na caixa de dilogo acima iro aparecer todos os certificados digitais vlidos abaixo da

entidade certificadora Raiz ICP Brasil.

importante ressaltar que, certificados digitais criados pelo ambiente piloto no sero aceitos

em ambiente de produo.

Selecione o certificado digital desejado e clique em OK.

Aps selecionar o certificado digital entre no ISS Curitiba utilizando o usurio e senha de

acesso ao mesmo.

Uma vez logado no sistema, entre no menu Contribuinte -> Certificado Digital -> Vincular

Ir aparecer uma tela de confirmao perguntando se voc realmente deseja vincular seu

certificado digital ao seu usurio do ISS Curitiba, como mostrado na figura abaixo:

Confirme a vinculao clicando em (Sim). Feito isso ir aparecer uma tela confirmando a

vinculao do certificado, como descrito abaixo:



Aps realizar os passos descritos acima o usurio j est apto a utilizar o WebService da Nota

Fiscal de Servios Eletrnica (Boa Nota).

4. Exportando o Certificado para um arquivo

A exportao do certificado digital para um arquivo se d pelo seguinte motivo.

Necessidade de integrao de sistemas legados com o sistema de emisso de NFS-e da

Prefeitura Municipal de Curitiba, onde toda requisio ao WebService necessrio anexar o

certificado digital da empresa prestadora do servio.

Na caixa de dilogo com os certificados digitais instalados em sua mquina, selecione um

certificado e clique no boto (Exibir Certificado).



Ir ser mostrado a seguinte tela:

Clique na aba (Detalhes)



Logo em seguida clique no boto (Copiar para arquivo). Onde ser apresentada a seguinte

tela:



Clique no boto (Avanar), e ser mostrado a tela abaixo, onde a opo (Sim, exportar a chave

particular) deve ser marcada.



Ir aparecer uma tela solicitando uma senha para o certificado, tal senha no necessria,

portanto deixe-a em branco.



Na prxima tela selecione o nome do arquivo para qual o certificado ser salvo e clique em

(Avanar), como mostra a figura abaixo:

Aps feito os passos acima ir aparecer a seguinte tela, onde deveremos clicar no boto

(Concluir).



Aps feito isso ir aparecer uma mensagem dizendo que a importao obteve xito, como

descrito abaixo.

5. Interfaces disponveis no WebService

5.1. Recepo de Lote de RPS

Atravs desta interface, os prestadores de servios podero enviar lotes de RPS emitidos em

seus sistemas, para que os mesmos sejam convertidos em Notas Fiscais de Servios

Eletrnica.

Destina-se prestadores de servios que desejam emitir NFS-e off-line ou em grandes

volumes.



5.2. Consulta a situao de lote de RPS

Aps o envio bem sucedido de um Lote de RPS, o WebService retorna o nmero do Lote de

RPS e o nmero do protocolo de recebimento do lote. Com esta interface, basta informar o

nmero do protocolo para receber a informao sobre o status de processamento do lote que

pode ser um dos seguintes:

No processado;

Processado com erros;

Processado com sucesso.

5.3. Consulta de Lote de RPS

Aps o processamento de um Lote de RPS, possvel consultar todas as informaes sobre o

lote de RPS, tais informaes como o nmero da NFS-e o valor gerado para crdito de

abatimento no IPTU, entre outras informaes.

Para o recebimento das informaes sobre as notas geradas atravs de um lote de RPS, basta

apenas informar o nmero do protocolo de recebimento do Lote de RPS e o WebService ir

retornar todas as informaes sobre as NFS-e geradas.

5.4. Consulta Nota Fiscal de Servios Eletrnica por RPS

Esta interface permite aos prestadores de servios consultarem as NFS-e emitidas por ele,

atravs das informaes do RPS anteriormente emitido pelo prestador.

5.5. Consulta Nota Fiscal de Servios Eletrnica

Esta interface permite aos prestadores de servios consultarem as NFS-e por ele emitidas.

5.6. Validao bsica do lote de rps Esta interface fornece um meio para o prestador de servios realizar uma pr-validao do arquivo XML a ser enviado com um Lote de RPS. Tal validao ir garantir que no iro faltar a informaes bsicas para a converso dos RPS.

5.7. Cancelamento de lote de NFS-e Esta interface permite aos prestadores de servios cancelarem um Lote de NFS-e, ou seja, permite o cancelamento de mais de uma NFS-e por vez. Destina-se a prestadores que desejam cancelar vrias NFS-e de uma nica vez. Um exemplo do arquivo XML pode ser encontrado em http://isscuritiba.curitiba.pr.gov.br/portalNfse/manuais.aspx no link EXEMPLO XML PARA CANCELAMENTO DE NFS-e.



5.8. Cancelamento de lote de RPS Esta interface permite aos prestadores de servios cancelarem um Lote de RPS enviado e processado com sucesso em um momento anterior ao momento da solicitao de cancelamento do Lote de RPS. Destina-se a prestadores que desejam invalidar algum lote de RPS enviado de forma incorreta.

6. Padres Tcnicos

A comunicao entre os sistemas dos prestadores de servios e o Sistema de Notas Fiscais de

Servios Eletrnica da Prefeitura Municipal de Curitiba ser baseada em WebService.

O meio fsico de comunicao utilizado ser a Internet, com o uso do protocolo SSL (Socket

Secure Layer), que alm de garantir a segurana das informaes trafegadas atravs da

Internet, permite a identificao do servidor e do cliente atravs de certificados digitais,

eliminando a necessidade do usurio se identificar atravs de usurio e senha.

O modelo de comunicao segue o padro para WebService definido pelo WS-I Basic Profile.A

troca de mensagens entre o WebService do sistema de NFS-e da Prefeitura Municipal de

Curitiba utilizar o protocolo SOAP, com troca de mensagens XML.

6.1. Padro de Certificado Digital

Os certificados digitais utilizados no Sistema de Notas Fiscais de Servios Eletrnica da

Prefeitura Municipal de Curitiba sero emitidos por Autoridade Certificadora credenciada pela

Infra-estrutura de Chaves Pblicas Brasileira ICP Brasil. Sero aceitos certificados do tipo A1

ou A3, devendo conter o CNPJ do prestador de servios.

Exclusivamente em ambiente piloto dever ser utilizado certificados digitais oferecidos pelo

prprio ambiente piloto. Vide captulo 1 e 2. Tais certificados gerados em ambiente piloto no

so vlidos para o ambiente de produo.

6.2. Assinatura em um lote de rps Existem 2 (duas) tags que devero ser transmitidas para o WebService e que devem ser assinadas digitalmente utilizando um certificado digital vlido emitido por uma entidade certificadora credenciada a ICP Brasil. As tags a serem assinadas digitalmente so (LoteRps e todas as ocorrncias de InfRps).

6.2.1. Assinando um lote de rps



Para realizar a assinatura de uma tag do lote de XML deve-se considerar todos os valores contidos dentro da prpria tag, incluindo tambm suas tags filhas. Por exemplo: Consideremos o seguinte trecho de um lote de RPS, tal trecho representa as informaes contidas em um RPS. 5 PMC 1 2010-08-02T09:08:47 1 2 2 1 5000.00 1.00 1.00 1.00 1.00 1.00 1.00 2 500.00 5000.00 10.00 4500.00 11.1. 6204010 620401000 PRODUTO SERVICO 4106902 76673904000140 00504532 99999999999 CLIENTE PESSOA FISICA RUA DAS FLORES 256 0292740 13246464



Para assinar digitalmente a tag InfRps devemos submeter a tag e todo o seu contedo

para o mtodo que ir realizar a assinatura do RPS. Que aps a sua assinatura ir ficar da

seguinte forma.

5

PMC

1

2010-03-02T09:08:47

1

2

2

1

5000.00

1.00

1.00

1.00

1.00

1.00

1.00

2

500.00

5000.00

10.00

4500.00

11.1.

6204010

620401000

PRODUTO SERVICO

4106902

76673904000140

00504532



27015444836

CLIENTE PESSOA FISICA - ISS CAMPINAS

RUA DAS FLORES

256

0292740

13246464

sTaMKAIuPQfnU115u/1YFLm9Yog=

NlIsfYevgiNy/aqkPi7D6m7O1JcP//xHX7J1YnlSvpuoictaI2H2Lz/19xIySziINnm

EV/vTzYaj5wi+gueP5370/cZcCrIj/IGRywh9FENy1auI7K8gOFhNl76aeEkuwWSDamDLe/cuf7zJt

OVs6qC2czHsSjYiF6EMd3pOBCw=

[email protected], CN=Equipe de Desenvolvimento

NFS-e,, O=Secretaria Municipal da Fazenda (Sefaz), L=Curitiba, S=Paran,

C=BR

MIIEqjCNONONONONONONONONOhkiG9w0BAQUFADAZMRcwFQYDVQ



QDEw4yMDAuMTg5LjE5Mi4XXXp8OjbyBkYSBFc2NvbGEgSW50ZXJuYWNpb25hbCBkZSBD

6.3. Schemas XML

Para garantir minimamente a integridade dos arquivos XML, o prestador de servios dever

submeter cada arquivo XML para validao atravs do arquivo com os schemas XML para

validao.

Um Schema XML define o contedo de uma mensagem XML, descrevendo os seus atributos,

elementos e a sua organizao, alm de estabelecer regras de preenchimento de contedo e

de obrigatoriedade de cada elemento ou grupo de informao.

O Schema XML poder ser encontrado em http://isscuritiba.curitiba.pr.gov.br/iss/nfse.xsd.

7. WebService NFS-e

O WebService do Sistema de Notas Fiscais de Servios Eletrnica da Prefeitura Municipal de

Curitiba, disponibiliza os servios que sero utilizados pelos sistemas dos prestadores de

servios. O mecanismo de utilizao do WebService segue as seguintes premissas:

Sero disponibilizados vrios mtodos dentro do mesmo WebService, cada um

desses mtodos executando uma funcionalidade especfica.

Alguns servios disponibilizados sero processados de forma assncrona, ou seja,

os dados sero recebidos e sero processados em um momento mais oportuno.

7.1. WSDL Para que os sistemas de informao dos prestadores de servios saibam quais parmetros

enviar ao WebService e quais parmetros sero retornados, os prestadores devero utilizar a

definio WSDL (Web Service Description Language, linguagem de descrio do servio Web).

A documentao do WSDL pode ser obtida atravs do endereo

http://pilotoisscuritiba.curitiba.pr.gov.br/nfse_ws/NfseWs.asmx?WSDL, para ambiente piloto e

para ambiente de produo dever ser obtido atravs do endereo

https://isscuritiba.curitiba.pr.gov.br/Iss.NfseWebService/nfsews.asmx?WSDL.



IMPORTANTE: O WSDL gerado tanto em ambiente piloto quanto em produo so idnticos.

7.2. Tipos Utilizados

Para obter a definio de todos os tipos utilizados pelo Sistema de Emisso de Notas Fiscais

de Servios Eletrnica basta acessar o endereo

http://isscuritiba.curitiba.pr.gov.br/iss/nfse.xsd.

7.3. Realizando uma chamada a um mtodo do WebService

Para a utilizao do WebService atravs de um sistema de informao de algum prestador de

servios necessrio anexar a requisio do servio o certificado digital do prestador de

servios.

IMPORTANTE: importante lembrar que para o certificado ser enviado junto a requisio ao Web Service a conexo dever utilizar HTTPS.

Tal certificado deve estar vinculado a um usurio dentro do ISS Curitiba, para que o sistema

possa reconhecer a empresa.

7.4. Realizando a validao bsica do arquivo de lote de rps Para garantir que o mnimo das informaes exigidas para a converso do Lote de RPS em Notas Fiscais de Servios Eletrnica, uma pr-validao do arquivo XML a ser enviado para processamento dever ser realizada. O elemento raiz do arquivo de Lote de RPS deve ficar da seguinte maneira:

Desta forma garantiremos que o arquivo a ser validado pegue todas as informaes dos

schemas de validao dos dados.

Tambm foi disponibilizado um programa que realiza tal pr-validao sem a necessidade de

conexo com o WebService. Tal programa est contido junto aos arquivos de exemplo (Vide

Captulo 8).



8. Arquivos de Exemplo

Para obter arquivos de exemplo acesse o link

http://isscuritiba.curitiba.pr.gov.br/iss/arquivos.zip

9. Resumo Links Abaixo seguem um resumo dos links necessrios para que as empresas configurem seus

sistemas para emisso de Notas Fiscais Eletrnicas optando pelo modo WebService:

1) Manual de Integrao de Sistemas - http://isscuritiba.curitiba.pr.gov.br/portalnfse/Manuais/NFSE-NACIONAL_ManualDeIntegracao_Curitiba.pdf

2) Manual de Utilizao de Envio Arquivos RPS -

http://isscuritiba.curitiba.pr.gov.br/portalnfse/Manuais/Manual_Layout_Arquivo_RPS_Curitiba.pdf

3) Definies de chamadas dos mtodos do WebService em ambiente piloto:

http://pilotoisscuritiba.curitiba.pr.gov.br/nfse_ws/nfsews.asmx

4) Endereo do WebService para ambiente de produo https://isscuritiba.curitiba.pr.gov.br/Iss.NfseWebService/nfsews.asmx

5) Definio WSDL do WebService em ambiente piloto:

http://pilotoisscuritiba.curitiba.pr.gov.br/nfse_ws/nfsews.asmx?wsdl

6) Definio WSDL do WebService em ambiente de produo: https://isscuritiba.curitiba.pr.gov.br/Iss.NfseWebService/nfsews.asmx?wsdl

7) Schema XSD para validao do XML:

http://isscuritiba.curitiba.pr.gov.br/portalnfse/manuais.aspx no link Arquivos XML Exemplo.

8) O endereo da rea de testes (piloto) :

http://pilotoisscuritiba.curitiba.pr.gov.br/iss/

9) O endereo do ambiente de produo : http://isscuritiba.curitiba.pr.gov.br/iss 10) Modelo XML para recepo de lote RPS em ambiente piloto:

http://isscuritiba.curitiba.pr.gov.br/portalnfse/manuais.aspx no link Arquivos XML Exemplo.

11) Para testes de envio via WS ser necessrio solicitar um certificado digital (testes)

no endereo: http://pilotoisscuritiba.curitiba.pr.gov.br:8080/certsrv/

12) Para vincular o certificado (teste) criado ao login do usurio para envio de WS: https://pilotoisscuritiba.curitiba.pr.gov.br/iss/Principal/frmVincularCertificadoDigital.aspx

13) Certificados raiz para o ambiente PILOTO Utilizao do WebService

http://isscuritiba.curitiba.pr.gov.br/portalnfse/manuais.aspx * Acessar o Item: CERTIFICADO RAZ - SERVIDOR PILOTO - 08/01/2013



14) Frum da Boa Nota Fiscal - http://pilotoisscuritiba.curitiba.pr.gov.br/forum_boanota/

Documents

Manual Utilizacao WebService