Version 12, last updated by fmertins at Jan 25 18:37 UTC

Decrease font size Decrease font size

Increase font size Increase font size

Print this page Print this page

Como utilizar



Primeiros passos

O NFePHP é uma API e para utilizá-la é simples. Veja a seguir o que você precisa, e como iniciar o uso.

0. Download do NFePHP

Faça o download do NFePHP (versão atual 2.0), através do subversion.

Em ambiente linux via linha de código os arquivos necessários podem ser baixados do repositório com o comando:

                svn co  http://subversion.assembla.com/svn/nfephp/branches/2.0/ /var/www/nfephp 

Esse comando irá criar uma cópia completa da API no diretório "/var/www/nfephp".

Caso você esteja usando ambiente windows recomendo o uso do "TortoiseSVN" (procure na internet). 

 

1. Pré-requisitos

  • possuir um sistema que emitia as notas em papel (para obter os dados da nota)*
  • Apache (servidor web)
  • PHP 5.3, OpenSSL, cURL, etc...

* você pode programar uma rotina independente para obter estes dados. Nosso projeto ainda não oferece esta rotina, mas dispõe de uma biblioteca opcional através da qual você pode utilizar um banco de dados (incluído e opcional) para gerar o XML da nota.

Ou

1.1 Dependências

O NFePHP utiliza algumas classes que devem estar habilitadas em sua instalação PHP*:

  • FPDF (classe para geração de arquivos pdf).
  • cURL e SOAP nativo do PHP (classe para comunicação com os WebServices das Secretarias da Fazenda de cada estado).
  • pear::Mail (conjunto de classes para envio de emails).
  • cURL, OpenSSL, pear
  • Modulos do PHP (php5-curl, php-pear, php5-gd) e recomendados para desenvolvimento (php5-xdebug, php5-mcrypt, php5-xsl, php5-cli)

 

2. Como utilizar o NFePHP

2.1 Gerando o TXT

Você deve programar uma rotina para gerar um TXT que contém os dados da nota (dados do cliente, dos produtos, impostos, frete, etc), seguindo a formatação deste manual:

http://www.emissornfe.fazenda.sp.gov.br/docs/[Emissor_NF-e]_Manual_de_layout_TXT-NF-e_v1.1.1.pdf

Você pode fazê-lo através do sistema que emitia as notas em papel* anteriormente.

*Caso você não tenha um sistema emissor de notas em papel, ou não possa alterá-lo para gerar o TXT, você pode utilizar o sistema B2Stok ( B2Stok.net ), que também já vem com o NFePHP para emitir suas notas no novo formato.

 

2.2 Preparando o NFePHP

 

Arquivos relacionados: config.php

Para o correto funcionamento da API, alguns parâmetros devem ser informados no arquivo de configuração, que é auto-explicativo.

 

2.3 Transformando o TXT em XML

Após gerar o TXT, use a biblioteca ConvertNFePHP.class.php , de conversão, para gerar o XML. Ou então você também pode gerar o XML por conta própria, utilizando a biblioteca DOM do PHP.

Veja um exemplo: 

<?php
<?php
/*
 * Exemplo de conversão de TXT para XML
 *
 */

require_once('../libs/ConvertNFePHP.class.php');
$cNFe = new ConvertNFePHP;

$arqtxt = './35100258716523000119550000000033453539003003-nfe.txt';
if ( is_file($arqtxt) ) {
    $arq = $cNFe->nfetxt2xml($arqtxt);
    $file = './'.$cNFe->chave.'-nfe.xml';
    if ( !file_put_contents($file, $arq) ) {
        echo "Erro na gravação da NFe em xml";
    }
}

2.4 Assinando um XML de NF-e

A partir do momento em que você tiver um arquivo XML de NF-e criado, deverá assinar digitalmente este arquivo, utilizando o certificado digital. É isto mesmo, ou seja, o certificado digital serve para assinar o arquivo XML, dando autenticidade ao mesmo. A etapa de assinar o XML significa, na prática, que serão inseridas algumas tags na estrutura do XML, tags estas referentes à assinatura.

Para assinar um arquivo XML de NF-e utilize o método ToolsNFePHP::signXML(). Este método espera dois parâmetros, o primeiro é a string contendo a estrutura do XML, ou seja, o XML propriamente dito. E o segundo parâmetro é a tag do XML a ser assinada, muito provavelmente será a tag "infNFe".

Por exemplo, dado o XML fictício abaixo:

<?xml version="1.0" encoding="utf-8"?><NFe xmlns="http://www.portalfiscal.inf.br/nfe"><infNFe Id="NFe43120103987283000133550010000006241607910981" versao="2.00"><ide><cUF>43</cUF><cNF>60791098</cNF><natOp>5.101 - VENDA</natOp><indPag>1</indPag><mod>55</mod><serie>1</serie><nNF>624</nNF><dEmi>2012-01-25</dEmi><tpNF>1</tpNF><cMunFG>4313409</cMunFG><tpImp>1</tpImp><tpEmis>1</tpEmis><cDV>1</cDV><tpAmb>2</tpAmb><finNFe>1</finNFe><procEmi>0</procEmi><verProc>2.02</verProc></ide><emit><CNPJ>03987283000133</CNPJ><xNome>MINHA EMPRESA TESTE LTDA.</xNome><xFant>MINHA EMPRESA FANTASIA TESTE</xFant><enderEmit><xLgr>RUA TESTE</xLgr><nro>123</nro><xBairro>CENTRO</xBairro><cMun>4312345</cMun><xMun>PORTO ALEGRE</xMun><UF>RS</UF><CEP>93000000</CEP><cPais>1058</cPais><xPais>BRASIL</xPais><fone>5111223344</fone></enderEmit><IE>0868689965</IE><CRT>1</CRT></emit><dest><CNPJ>99999999000191</CNPJ><xNome>NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL</xNome><enderDest><xLgr>AV. DOS TESTES</xLgr><nro>202</nro><xBairro>CENTRO</xBairro><cMun>4369854</cMun><xMun>PORTO ALEGRE</xMun><UF>RS</UF><CEP>93000000</CEP><cPais>1058</cPais><xPais>BRASIL</xPais></enderDest><IE>ISENTO</IE></dest><det nItem="1"><prod><cProd>15036</cProd><cEAN/><xProd>PRODUTO TESTE REF 123123</xProd><NCM>84123123</NCM><CFOP>5101</CFOP><uCom>UN</uCom><qCom>1.0000</qCom><vUnCom>590.0000</vUnCom><vProd>590.00</vProd><cEANTrib/><uTrib>UN</uTrib><qTrib>1.0000</qTrib><vUnTrib>590.0000</vUnTrib><indTot>1</indTot></prod><imposto><ICMS><ICMSSN101><orig>0</orig><CSOSN>101</CSOSN><pCredSN>2.82</pCredSN><vCredICMSSN>16.64</vCredICMSSN></ICMSSN101></ICMS><PIS><PISOutr><CST>99</CST><vBC>0.00</vBC><pPIS>0.00</pPIS><vPIS>0.00</vPIS></PISOutr></PIS><COFINS><COFINSOutr><CST>99</CST><vBC>0.00</vBC><pCOFINS>0.00</pCOFINS><vCOFINS>0.00</vCOFINS></COFINSOutr></COFINS></imposto></det><total><ICMSTot><vBC>0.00</vBC><vICMS>0.00</vICMS><vBCST>0.00</vBCST><vST>0.00</vST><vProd>590.00</vProd><vFrete>0.00</vFrete><vSeg>0.00</vSeg><vDesc>0.00</vDesc><vII>0.00</vII><vIPI>0.00</vIPI><vPIS>0.00</vPIS><vCOFINS>0.00</vCOFINS><vOutro>0.00</vOutro><vNF>590.00</vNF></ICMSTot></total><transp><modFrete>1</modFrete></transp><cobr><dup><nDup>624</nDup><dVenc>2013-02-08</dVenc><vDup>590.00</vDup></dup></cobr><infAdic><infCpl>TESTE DE INFORMACOES ADICIONAIS</infCpl></infAdic></infNFe></NFe>

Após ser assinado, ele ficará assim:

<?xml version="1.0" encoding="utf-8"?><NFe xmlns="http://www.portalfiscal.inf.br/nfe"><infNFe Id="NFe43120103987283000133550010000006241607910981" versao="2.00"><ide><cUF>43</cUF><cNF>60791098</cNF><natOp>5.101 - VENDA</natOp><indPag>1</indPag><mod>55</mod><serie>1</serie><nNF>624</nNF><dEmi>2012-01-25</dEmi><tpNF>1</tpNF><cMunFG>4313409</cMunFG><tpImp>1</tpImp><tpEmis>1</tpEmis><cDV>1</cDV><tpAmb>2</tpAmb><finNFe>1</finNFe><procEmi>0</procEmi><verProc>2.02</verProc></ide><emit><CNPJ>03987283000133</CNPJ><xNome>MINHA EMPRESA TESTE LTDA.</xNome><xFant>MINHA EMPRESA FANTASIA TESTE</xFant><enderEmit><xLgr>RUA TESTE</xLgr><nro>123</nro><xBairro>CENTRO</xBairro><cMun>4312345</cMun><xMun>PORTO ALEGRE</xMun><UF>RS</UF><CEP>93000000</CEP><cPais>1058</cPais><xPais>BRASIL</xPais><fone>5111223344</fone></enderEmit><IE>0868689965</IE><CRT>1</CRT></emit><dest><CNPJ>99999999000191</CNPJ><xNome>NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL</xNome><enderDest><xLgr>AV. DOS TESTES</xLgr><nro>202</nro><xBairro>CENTRO</xBairro><cMun>4369854</cMun><xMun>PORTO ALEGRE</xMun><UF>RS</UF><CEP>93000000</CEP><cPais>1058</cPais><xPais>BRASIL</xPais></enderDest><IE>ISENTO</IE></dest><det nItem="1"><prod><cProd>15036</cProd><cEAN/><xProd>PRODUTO TESTE REF 123123</xProd><NCM>84123123</NCM><CFOP>5101</CFOP><uCom>UN</uCom><qCom>1.0000</qCom><vUnCom>590.0000</vUnCom><vProd>590.00</vProd><cEANTrib/><uTrib>UN</uTrib><qTrib>1.0000</qTrib><vUnTrib>590.0000</vUnTrib><indTot>1</indTot></prod><imposto><ICMS><ICMSSN101><orig>0</orig><CSOSN>101</CSOSN><pCredSN>2.82</pCredSN><vCredICMSSN>16.64</vCredICMSSN></ICMSSN101></ICMS><PIS><PISOutr><CST>99</CST><vBC>0.00</vBC><pPIS>0.00</pPIS><vPIS>0.00</vPIS></PISOutr></PIS><COFINS><COFINSOutr><CST>99</CST><vBC>0.00</vBC><pCOFINS>0.00</pCOFINS><vCOFINS>0.00</vCOFINS></COFINSOutr></COFINS></imposto></det><total><ICMSTot><vBC>0.00</vBC><vICMS>0.00</vICMS><vBCST>0.00</vBCST><vST>0.00</vST><vProd>590.00</vProd><vFrete>0.00</vFrete><vSeg>0.00</vSeg><vDesc>0.00</vDesc><vII>0.00</vII><vIPI>0.00</vIPI><vPIS>0.00</vPIS><vCOFINS>0.00</vCOFINS><vOutro>0.00</vOutro><vNF>590.00</vNF></ICMSTot></total><transp><modFrete>1</modFrete></transp><cobr><dup><nDup>624</nDup><dVenc>2013-02-08</dVenc><vDup>590.00</vDup></dup></cobr><infAdic><infCpl>TESTE DE INFORMACOES ADICIONAIS</infCpl></infAdic></infNFe><Signature xmlns="http://www.w3.org/2000/09/xmldsig#"><SignedInfo><CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/><SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/><Reference URI="#NFe43120101951363000175550010000006241607910981"><Transforms><Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/><Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/></Transforms><DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/><DigestValue>w9ST4BFe2YG5i/ifHycd4fBMQ=</DigestValue></Reference></SignedInfo><SignatureValue>El98tgmZRnakzzbLqjzuLDlWzL5cZJc8Xg8BOnffj5SIfqhuSvq/v7UOy6Sz80u4dV1GCFuycOV4wHdIfitzlmnfiDJkjIpjrrYOwOpiL5DCXgPWcbRwAVjIA04T/d6AL/dErwKvpS1GBAySz/Ds6KX03jtheFNgCpyeg=</SignatureValue><KeyInfo><X509Data><X509Certificate>MIIGHjCBQagAwIBAgIQMjAxMTA0MTExMTU0MTQ4MDANBgkqhkiG9w0BAQUADCBijELMAkGA1UEBhMCQlIxEzARBgNVBAoTCklDUC1CcmFzaWwxNjA0BgNVBAsTLVNlY3JldGFyaWEgZGEgUmVjZWl0YSBGZWRlcmFsIGRvIEJyYXNpbCAtIFJGQjEuMCwGA1UEAxMlQXV0b3JpZGFkZSBDZXJ0aWZpY2Fkb3JhIGRvIFNFUlBST1JGQjAeFw0xMTA0MTExNTIxMjRaFw0xMjA0MTAxNDE4MzZaMIIBBTELMAkGA1UEBhMCQlIxEzARBgNVBAoTCklDUC1CcmFzaWwxNjA0BgNVBAsTLVNlY3JldGFyaWEgZGEgUmVjZWl0YSBGZWRlcmFsIGRvIEJyYXNpbCAtIFJGQjERMA8GA1UECxMIQ09SUkVJT1MxEzARBgNVBAsTCkFSQ09SUkVJT1MxFjAUBgNVBAsTDVJGQiBlLUNOUEogQTExFjAUBgNVBAcTDU5PVk8gSEFNQlVSR08xCzAJBgNVBAgTAlJTMUQwQgYDVQQDEztCRU5LTElOIElORFVTVFJJQSBDT01FUkNJTyBFIEVYUE9SVEFDQU8gTFREQTowMTk1MTM2MzAwMDE3NTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA0wJ8qZsdl94R7nU7vksHlcUcv/HXxzkSQERr/ty9m7intf7Gzzq7fACKlkPqLWH/ylonHa6dkV54vk6+F0s005CNGIvsN5clasltuFy2Ud+lwmTnuK6KBgeT+g0hyGvUeJ+mW/puETY+DI83rxJcyxRQ/UM633Zgozz3uq0CAwEAAaOCAoQwggKAMA8GA1UdEwEB/wQFMAMBAQAwHwYDVR0jBBgwFoAUuSKLhiR56Kt5yk7jGg7Ta10kRQwDgYDVR0PAQH/BAQDAXgMGAGA1UdIARZMFcwVQYGYEwBAgEKMEswSQYIKwYBBQUHAgEWPW0dHBzOi8vY2NkLnNlcnByby5nb3YuYnIvYWNzZXJwcm9yZmIvZG9jcy9kcGNhY3NlcnByb3JmYi5wZGYwgb4GA1UdEQSBtjCBs6A9BgVgTAEDBKA0BDIyODAzMTk1MDA3NTMzODcwMDAwMDAwMDAwMDAwMDAwMDAwMDcwMDU3MTEyNzVTU1BSU6AoBgVgTAEDAqAfBB1DTEFVREVNSVIgUk9HRVJJTyBCRU5LRU5TVEVJTqAZBgVgTAEDA6AQBA4wMTk1MTM2MzAwMDE3NaAXBgVgTAEDB6AOBAwwMDAwMDAwMDAwMDCBFGphaW1lQGdsb2JoYWwuY29tLmJyMCAGA1UdJQEB/wQWMQGCCsGAQUFBwMCBggrBgEFBQcDBDCBqAYDR0fBIGgMIGdMDKgMKAuhixodHRwOi8vY2NkLnNlcnByby5nb3YuYnIvbGNyL2Fjc2VycHJvcmZiLmNybDAzoDGgL4YtHR0cDovL2NjZDIuc2VycHJvLmdvdi5ici9sY3IvYWNzZXJwcm9yZmIuY3JsMDKgMKAuhixodHRwOi8vd3d3Lml0aS5nb3YuYnIvc2VycHJvL2Fjc2VycHJvcmZiLmNybDBMBggrBgEFBQcBAQRAMD4wPAYIKwYBBQUHMAKGMGh0dHA6Ly9jY2Quc2VycHJvLmdvdi5ici9jYWRlaWFzL2Fjc2VycHJvcmZiLnA3YjANBgkqhkiG9w0BAQUFAAOCAQEAuWANnthFd9x6a3PwBNHfn5cWIghDmNPbfZdxeWL3rtqs+WfD2UQ4RxcHBuCCvHX3oorng71Ot01OXXmsXl9SqmT9hPrxQ3eh4ckJ2Ta3I1roUfT07TUFXupcnXwJY56dvmLbXGAGWqwwMOIUbFWnEYa4LzxPE2zhyGQEclHTcOnnVZKzXp2MbA8aP5ldnTb/kQeeZ/l6xj4kukkLImLjwEIG2+oa2iEVj+ScN/FWzwx5DlM95H0x9zWDQmRj8KQF7FvO1jLShyPzKiTsCnQycIqfzi+g6ReoGX3LJxN70u5+4GxEAOszFEe0qbY7bGUCc89MfV239UJv5OyQ==</X509Certificate></X509Data></KeyInfo></Signature></NFe>

Script de exemplo para assinar um XML:

<?php
/*
 * Exemplo de assinatura de um XML de NF-e
 *
 */

require_once('../libs/ToolsNFePHP.class.php');

// Instancia um objeto da classe "Tools" da API.
$tools = new ToolsNFePHP();

// Esta variável deve conter o XML inteiro da NF-e a ser assinada.
$sXml = "<?xml version="1.0" encoding="utf-8"?><NFe ... </NFe>";

// Chama o método "signXML()" da API.
$sXmlAssinado = $this->toolsNFe->signXML($sXml, 'infNFe');

// Caso a assinatura tenha falhado por algum motivo, o método retorna FALSE.
if ($sXmlAssinado === FALSE) {
   die("Erro na assinatura do XML de NF-e");
}

// Se o método não retornou FALSE, então ele retornou a nova string do XML com as tags referentes à assinatura.
var_dump($sXmlAssinado);

2.5 Validando um XML de NF-e

Pendente... Validar o XML contra o XSD...

2.6 Transmitindo um XML de NF-e

Pendente... Transmitir o XML para a SEFAZ...