Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nfephp-org/sped-gnre

:octocat: API para emissão de guias GNRE para a SEFAZ
https://github.com/nfephp-org/sped-gnre

certificado gnre-php governo governo-federal guia php sefaz sped sped-fiscal

Last synced: 6 days ago
JSON representation

:octocat: API para emissão de guias GNRE para a SEFAZ

Host: GitHub
URL: https://github.com/nfephp-org/sped-gnre
Owner: nfephp-org
License: gpl-3.0
Created: 2014-07-27T19:11:40.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2024-01-09T19:54:04.000Z (12 months ago)
Last Synced: 2024-09-15T02:56:03.432Z (3 months ago)
Topics: certificado, gnre-php, governo, governo-federal, guia, php, sefaz, sped, sped-fiscal
Language: PHP
Homepage:
Size: 3.36 MB
Stars: 62
Watchers: 22
Forks: 59
Open Issues: 9
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        [![Build status (PHP Composer)](https://github.com/nfephp-org/sped-gnre/actions/workflows/php.yml/badge.svg)](https://github.com/nfephp-org/sped-gnre/actions/workflows/php.yml)

[![Coverage Status](https://coveralls.io/repos/marabesi/gnrephp/badge.svg)](https://coveralls.io/r/nfephp-org/sped-gnre)

[![Total Downloads](https://poser.pugx.org/marabesi/gnre/downloads)](https://packagist.org/packages/nfephp-org/sped-gnre)

[![Latest Stable Version](https://poser.pugx.org/marabesi/gnre/v/stable)](https://packagist.org/packages/nfephp-org/sped-gnre)

[![Latest Unstable Version](https://poser.pugx.org/marabesi/gnre/v/unstable.png)](https://packagist.org/packages/nfephp-org/sped-gnre)

[![License](https://poser.pugx.org/marabesi/gnre/license)](https://packagist.org/packages/nfephp-org/sped-gnre)

Atenção!!

=================

Caso encontre algum estado que possua uma regra especial para gerar uma GNRE por favor informar abrindo uma **issue**.

Dessa forma podemos manter a API atualizada e ajudar a todos que utlizam a GNRE PHP

Atenção 2!!

=================

Se você possui um certificado da certisign e está com o erro "Bad request" veja a solução encontrada pelo [renandelmonico](https://github.com/renandelmonico) utilizando

as classes da sped-common nesse [link](https://groups.google.com/d/msg/gnrephp/kbNWB3aEBbs/0g067FKlBgAJ)

Os certificados da certisign possuem algum problema em que não é possível extrair a cadeia de certificação, portanto é necessário fazer o download da cadeia manualmente nesse [link](https://www.certisign.com.br/duvidas-suporte/downloads/hierarquias/icp-brasil/ac-instituto-fenacon-rfb) (Hierarquia V5).

Após o download é necessário extrair usando o openssl, copiar o conteúdo gerado pelos 3 certificados e colar em um novo arquivo .pem.

```sh

openssl x509 -inform der -in ARQUIVO.cer -pubkey -noout > ARQUIVO.pem

```

Depois de realizar o processo acima, é necessário utilizar o método addCurlOption da classe Sped\Gnre\Webservice\Connection para alterar algumas configurações e informar manualmente a cadeia de certificação.

```php

$webService->addCurlOption([

    CURLOPT_SSL_VERIFYHOST => 2,

    CURLOPT_SSL_VERIFYPEER => 1,

    CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1,

    CURLOPT_CAINFO => 'ARQUIVO.pem'

]);

```

Versões suportadas

=================

|PHP| GNRE|

|---|-----|

| PHP 5.6 | 0.1.4 |

| HHVM | 0.1.4 |

| PHP 7.0 | 0.1.5 |

| PHP 7.3 | 0.1.6 |

Antes de usar a API

=================

- Verifique se seu certificado digital não foi expedido através da [certisign](https://www.certisign.com.br), pois existe um problema na cadeia do certificado que impossibilita a emissão de guias GNRE. Certificados expedidos através do [SERASA](https://serasa.certificadodigital.com.br/) funcionam normalmente para a emissão (até agora nenhum erro foi relatado).

- É permitido utilizar o mesmo certificado utilizado para emitir NF-e.

- É necessário entrar em contato com a SEFAZ de cada estado pedindo liberação do serviço de emissão de GNRE.

- Leita todos os tópicos no FAQ oficial em http://www.gnre.pe.gov.br/gnre/portal/faq.jsp. Os tópicos abordados são muito úteis para quem está começando nesse serviço.

GNRE PHP

=================

Objetivo

-----

 API possibilita a comunicação com a SEFAZ para a emissão da nota GNRE (Guia Nacional de Recolhimento de Tributos Estaduais).

 A API GNRE tem como maior inspiração a API NFEPHP que você pode encontrar através do link https://github.com/nfephp

Dependências

-------

* [Apache](http://httpd.apache.org/) / [Nginx](http://nginx.org/)

* [PHP 5.3+](http://php.net)

* Extensões PHP

 * [DOMDocument](http://br2.php.net/manual/en/domdocument.construct.php)

 * [cURL](http://br2.php.net/manual/book.curl.php)

 * [GD (Utilizada para renderizar o código de barras)] (http://php.net/manual/pt_BR/book.image.php)

------

Road-map

-----

Atualmente estamos utilizando o trello para gerenciar o que será implementado nas próximas versões e melhorias na API, esse road map poe ser acessado em https://trello.com/b/kNP1tvsi/gnre-api-github

------

Informações úteis

-----

|Descrição|Endereço|

|---------|--------|

|Grupo de discussão | https://groups.google.com/forum/#!forum/gnrephp|

|Site oficial do governo | http://www.gnre.pe.gov.br/gnre/index.html|

|Site do Projeto | http://nfephp-org.github.io/sped-gnre/|

|Wiki, onde é possível encontrar maiores informações de como utilizar a API | https://github.com/nfephp-org/sped-gnre/wiki|

|Site oficial da SEFAZ de todo os estados|http://www.gnre.pe.gov.br/gnre/portal/linksUteis.jsp|

1. Antes de gerar qualquer guia GNRE com o seu certificado, tenha **CERTEZA** que você possui autorização para isso. A geração de

GNRE depende de cada estado, ou seja, se você deseja gerar a guia para o Acre (com destino ao Acre) tenha certeza que

já pediu a liberação do certificado no SEFAZ Acre e repita esse processo para cada estado.

Documentação

------

* Documentação da GNRE PHP gerada com o PHPDOC pode ser visualizada [aqui](http://nfephp-org.github.io/sped-gnre//doc/namespaces/Gnre.html)

* Nosso wiki de como utilizar a API e gerar as GNRES está disponível [aqui no github](https://github.com/nfephp-org/sped-gnre/wiki)

* Exemplos com código fonte são encontrados na pasta [exemplos/](https://github.com/nfephp-org/sped-gnre/tree/master/exemplos)

Instalação via composer

------

Adicionando a GNRE PHP em um projeto existente com o composer

Caso você não possua o composer veja [esse link](https://getcomposer.org/doc/01-basic-usage.md) antes de prosseguir

Adicione a dependência da GNRE PHP no arquivo composer.json :

Para PHP <= 5.5

``` json

{

    "nfephp-org/sped-gnre": "0.1.1"

}

```

Para PHP = 5.6

``` json

{

    "nfephp-org/sped-gnre": "0.1.4"

}

```

Para PHP >= 7.0

``` json

{

    "nfephp-org/sped-gnre": "0.1.5"

}

```

Atualize suas depedências existentes no composer :

``` terminal

composer update

```

-----

Possíveis erros

-----

Erro : **unable to use client certificate (no key found or wrong pass phrase?)**

Se você está obtendo essa mensagem após enviar a requisição para o web service da SEFAZ verifique a senha que você está utilizando, pois esse erro ocorre quando a senha informada não bate com a senha do certificado utilizado

Erro: **[InvalidArgumentException]

Could not find package marabesi/gnre at any version for your minimum-stability (stable). Check the package spelling or your minimum-stability**

Esse problema ocorre pois não estamos informando ao composer qual a versão mínima que queremos utilizar, para resolver esse problema basta adicionar a seguinte linha no seu arquivo composer.json

``` json

{

    "minimum-stability": "dev"

}

```

-----

Quick start

-----

Clone o repositório do projeto

``` terminal

git clone https://github.com/nfephp-org/sped-gnre.git

```

Vá para a pasta de exemplos

```

cd exemplos/

```

Rode o servidor built-in do PHP

```

php -S localhost:8181

```

Abra o seu navegador e digite a seguinte URL

```

http://localhost:8181/gerar-xml.php

```

-----

Caso queira ver outros exemplos utilizados pela API acesse esse link https://github.com/nfephp-org/sped-gnre/tree/master/exemplos