- 7.5. API da NFS-e
7.5.2. Download da NFS-e - 7.5.1. Obter NFS-e vinculadas a um interessado
« Anterior - 7.6. WS da NFC-e - SEFAZ/SP
Próximo »
7.5.2. Download da NFS-e
Obter o XML da NFS-e pela chave de acesso da NFS-e.
Assinatura
string getNFSe( int tipoAmbiente, string chaveAcesso, string nomeCertificado, out int httpStatusCode, out string httpStatus, out string respostaAPI, out string versaoAplicativo, out string dataHoraProcessamento, out string erros, out string nfseXmlZipB64);
Descrição:
Obter o XML da NFS-e pela chave de acesso da NFS-e.
Preenchimento do nomeCertificado
informar o Nome do titular (campo Assunto) do certificado digital a ser utilizado na conexão SSL, formas possíveis:
1. uso de certificado digital existente no repositório MY do CSP do usuário corrente (currentuser)
É a forma de mais comum de uso, cabe ressaltar que é a única forma de uso de certificado digital do tipo A3 que a DLL oferece.
O usuário deve passar como parâmetro o campo assunto do certificado no parâmetro NomeCertificado para que a DLL localize um certificado digital com mesmo assunto no repositório MY do currentuser do equipamento.
Esta forma de uso requer a prévia instalação do certificado digital na conta do usuário do Windows (logon) que irá utilizar o certificado digital.2. uso de certificado digital em arquivo no formato pfx
Permite o de uso de certificado digital em arquivo formato pfx.
O caminho da localização (path) do arquivo pfx deve ser passado para a DLL no formato: ARQUIVO | [nome do arquivo pfx com caminho completo] | [senha do arquivo] no parâmetro NomeCertificado, ex.: "ARQUIVO|c:\certificado.pfx|senha".
Esta opção só funciona com certificado digital do tipo A1.3. uso de certificado digital em string base64
Permite uso o arquivo do certificado digital em formato pfx convertido em uma string base64. O certificado digital em string base64 deve ser passado para a DLL no formato: CERTIFICADO | [string base64 do arquivo pfx] | [senha do arquivo] no parâmetro NomeCertificado, ex.: "CERTIFICADO|MIIGoDCCBYigAwIBAgIQep(arquivo pfx do certificado digital convertido em base64...)QQDExNBQy|senha".
Esta opção só funciona com certificado digital do tipo A1. É uma opção de uso que oferece maior versatilidade, pois permite o armazenamento do certificado digital em banco de dados na aplicação. É a forma mais indicada para uso em ASP.NET.
Parâmetros:
| nome | tipo | fluxo | descrição |
|---|---|---|---|
| tipoAmbiente | inteiro | entrada | informar o código do ambiente desejado: 1- produção ou 2-homologação |
| chaveAcesso | string | entrada | informar a chave de acesso da NFS-e desejada, é necessário que interessado seja participante da NFS-e, a validação é realizada pelo CNPJ do certificado digital utilizado. |
| NomeCertificado | string | entrada | informar o certificado digital que será utilizado para assinatura: 1. informar o assunto do certificado digital que deve existir no repositório MY do current user, ex.: "CN=NFe - Associacao NF-e:99999090910270, C=BR, L=PORTO ALEGRE, O=Teste Projeto NFe RS, OU=Teste Projeto NFe RS, S=RS". 2. informar: ARQUIVO | [nome do arquivo pfx com caminho completo] | [senha do arquivo] para uso do certificado digital em arquivo pfx, ex.: "ARQUIVO|c:\certificado.pfx|senha". 3. informar: CERTIFICADO | [string base64 do arquivo pfx] | [senha do arquivo] no parâmetro NomeCertificado para passar uma string contendo um certificado digital em base64, ex.:"CERTIFICADO|MIIGoDCCBYigAwIBAgIQep(arquivo pfx do certificado digital convertido em base64...)QQDExNBQy|senha". (novas opções) |
| httpStatusCode | inteiro | saída | retorna o código de resultado da chamada da API. exemplo: sucesso = 200, rejeição/erro = 400, 401, 404, etc. |
| httpStatus | string | saída | retorna a mensagem de resultado da chamada da API |
| respostaAPI | string | saída | retorna a mensagem Json de resposta da API |
| versaoAplicativo | string | saída | retorna a versão do aplicativo da API |
| dataHoraProcessamento | string | saída | retorna a Data e hora da mensagem de Resposta. |
| erros | string | saída | retorna a lista de erros. |
| nfseXmlGzipB64 | string | saída | retorna a NFS-e compactada em codificação base 64, o XML da NFS-e descompactada retorna como resposta da chamada da getNFSe |
Retorno:
A chamada devolve uma string com o XML da NFS-e consultada.
- 7.5.2. Download da NFS-e
7.5. API da NFS-e - « Anterior
7.5.1. Obter NFS-e vinculadas a um interessado - Próximo »
7.6. WS da NFC-e - SEFAZ/SP