{"id":13813385,"url":"https://github.com/stavarengo/php-sigep","last_synced_at":"2025-05-15T04:08:13.194Z","repository":{"id":10205766,"uuid":"12299739","full_name":"stavarengo/php-sigep","owner":"stavarengo","description":"PHP client library for the Brazilian Post Office Web Service. Integração com Web Service do Correios. Consulta preços e prazos, imprime etiquetas e PLP, etc.","archived":false,"fork":false,"pushed_at":"2024-08-01T19:31:47.000Z","size":16018,"stargazers_count":361,"open_issues_count":11,"forks_count":246,"subscribers_count":39,"default_branch":"master","last_synced_at":"2025-04-11T15:57:01.325Z","etag":null,"topics":["correios","etiquetas","etiquetas-de-postagem","php","php-sigep","plp"],"latest_commit_sha":null,"homepage":"https://phpsigep.stavarengo.me","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stavarengo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-08-22T14:55:59.000Z","updated_at":"2025-04-07T23:30:48.000Z","dependencies_parsed_at":"2023-02-19T05:15:37.842Z","dependency_job_id":"3b8ba238-55b3-48f6-88b0-6281fc417444","html_url":"https://github.com/stavarengo/php-sigep","commit_stats":{"total_commits":419,"total_committers":82,"mean_commits":5.109756097560975,"dds":0.7470167064439142,"last_synced_commit":"7ecde52177be8d46bb8b249df2e2ec7cf6f52864"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stavarengo%2Fphp-sigep","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stavarengo%2Fphp-sigep/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stavarengo%2Fphp-sigep/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stavarengo%2Fphp-sigep/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stavarengo","download_url":"https://codeload.github.com/stavarengo/php-sigep/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254214689,"owners_count":22033740,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["correios","etiquetas","etiquetas-de-postagem","php","php-sigep","plp"],"created_at":"2024-08-04T04:01:15.977Z","updated_at":"2025-05-15T04:08:08.176Z","avatar_url":"https://github.com/stavarengo.png","language":"PHP","funding_links":[],"categories":["PHP"],"sub_categories":[],"readme":"### Ajude o projeto a crescer. Envie pull request de suas alterações no código fonte ou na documentação do projeto.\r\n\r\nPHP SIGEP - Correios\r\n====================\r\n\r\n* Baixe a última versão estável aqui: [https://github.com/stavarengo/php-sigep/tags](https://github.com/stavarengo/php-sigep/tags)\r\n\r\nImplementação do Web Service dos correios SIGEP Web.\r\n### [Veja a demo online, exemplos e documentação em nossa página](https://phpsigep.stavarengo.me/).\r\n\r\nIntegração com Web Service do Correios. Consulta preços e prazos, imprime etiquetas e PLP, etc.\r\nEsta API pode:\r\n* Calcular preços e prazos de entrega da encomenda.   \r\n* Obter os dados de rastreamento das encomendas.   \r\n* Verificar se um tipo de serviço (Sedex, PAC, ...) é permitido entre dois endereços.   \r\n* Gerar e enviar o XML da pre-lista de postagem (PLP) para o Correios.   \r\n* Gerar novos números de etiquetas de postagem.\r\n* Criar e/ou verificar validade do dígito verificador das etiquetas (através do web service ou não).   \r\n* Gerar o relatório da PLP no formato PDF.   \r\n* Gerar as etiquetas de postagem no formato PDF.\r\n* Gerar em PDF as chancelas para cada tipo de serviço (logo de cada tipo de servico).\r\n* Obter dados de PLP após postagem [processamento pelo Sara]\r\n* [Novo] Suspender a entrega de postagem (Também chamado de Entrega Interativa)\r\n* [Novo] Listagem de Agências (Necessário para o Clique e Retire)\r\n* [Novo] Gerar as etiquetas de postagem no formato PDF para o Clique e Retire.\r\n\r\nRequisitos\r\n---\r\n\r\n* PHP \u003e= 5.4.0\r\n* Se você precisar imprimir as etiquetas e relatórios, baixe também o FPDF 1.7 [www.fpdf.org](http://www.fpdf.org/).   \r\n  Não esqueça de configurar o FPDF para ser auto carregado antes de tentar imprimir os relatórios.\r\n\r\nInstalação com Composer (recomendado)\r\n---\r\n\r\n* Nós não controlamos versão através das tags, porem, a branch master só é atualizada quando o código está estável.\r\n  Portanto, a versão estável mais atual sempre será a branch master.\r\n\r\nAdicione as seguintes linha ao seu arquivo `composer.json`:\r\n\t\"stavarengo/php-sigep\": \"dev-master\"    \r\n    \"stavarengo/php-sigep-fpdf\": \"dev-master\"\r\n\r\nE então execute `composer update` via linha de comando.\r\n\r\n\r\n\r\nInstalação manual\r\n---\r\n\r\n* Nós não controlamos versão através das tags, porem, a branch master só é atualizada quando o código está estável.\r\n  Portanto, a versão estável mais atual sempre será a branch master.\r\n\r\n* Faça o download da última versão.\r\n* Para usar as classe do php-sigep, você só precisa carregar o arquivo \"php-sigep/src/PhpSigep/Bootstrap.php\". Isso fara com que o loader seja registrado.\r\n\r\n# Problemas Comuns\r\n\r\n## Autorização de acesso negada para o sistema\r\nAntes de utilizar este projeto em modo produção, é necessário solicitar ao representante comercial dos correios habilitação e senha para o webservice dos correios.\r\n\r\n## Estou tendo problema ao utilizar o ambiente de homologação\r\nSe você está recebendo a mensagem abaixo ao tentar utilizar o ambiente de homologação, significa que o webservice do correio está temporariamente indisponível. Não adianta criar _issue_, o melhor a fazer é aguardar ou tentar entrar em contato com o suporte técnico do correio.\r\n\r\n**Mensagem de erro**: Parsing WSDL: Couldn't load from 'https://apphom.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl' : failed to load external entity \"https://apphom.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsd\r\n\r\n## Problemas com o PHP 5.3\r\nEste problema foi reportado aqui: https://github.com/stavarengo/php-sigep/issues/35\r\nAlguns usuarios tiveram problemas de conexão e autentificação com WebService do Correios em ambiente de produção devido a versão do PHP.\r\nPara resolver o problema, você pode ou utilizar uma versão masi rescente do PHP (\u003e=5.4) ou fazer o download do WSDL do Correios e utilizar ele no seu servidor para fazer conexão.\r\nCaso escolha fazer o download o WSDL, siga os passos abaixo:\r\n\u003ca id=\"example-change-wsdl\"\u003e\u003c/a\u003e\r\n1. Salve este arquivo em seu ambiente local https://apps.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl\r\n2. Altere as configurações do seu ambiente de produção para apotar para o arquivo que você baixou. Vejo exemplo abaixo.\r\n```php\r\n$config = new \\PhpSigep\\Config();\r\n$config-\u003esetEnv(\\PhpSigep\\Config::ENV_PRODUCTION);\r\n$config-\u003esetWsdlAtendeCliente('CAMINHO-DO-SEU-ARQUIVO-LOCAL');\r\n\\PhpSigep\\Bootstrap::start($config);\r\n```\r\nOBS: Não irá funcionar em um servidor local, como Wamp, Xammp entre outros.\r\n\r\nFunções\r\n---\r\n\r\nCache\r\n---\r\n\r\nO componente de cache do PhpSigep foi inspirado no [componente de cache do Zend Framework](http://framework.zend.com/manual/2.3/en/index.html#zend-cache).\r\n\r\nPor padrão o cache do PhpSigep está desabilitado.   \r\nEste cache armazena algumas respostadas do WebService dos correios que podem ser reutilizadas posteriomente.\r\nAlem de aumentar a velocidade de respostas das requisições, também evitamos que os usuários fiquem impedidos de continuar\r\nmesmo quando o servidor do Correios esteja instavel (acredite: ele fica instável com muita frequencia).\r\n\r\nPara habilitar o cache, use a chave \"cacheOptions\" ao criar a configuração do PhpSigep.\r\nEx:\r\n    ```php\r\n        new \\PhpSigep\\Config(\r\n            array(\r\n                'cacheOptions' =\u003e array(\r\n                    'storageOptions' =\u003e array(\r\n                        'enabled' =\u003e true,\r\n                        'ttl' =\u003e 60*60*24*7,// Uma semana\r\n                    ),\r\n                ),\r\n                ...\r\n            ),\r\n        );\r\n    ```\r\nDentro do `array` `storageOptions` você pode usar o nome de qualquer atributo da classe `PhpSigep\\Cache\\Storage\\Adapter\\AdapterOptions`.\r\n\r\nContribua\r\n---\r\n\r\nPara executar a testsuite, execute `./vendor/bin/phpunit` via linha de comando.\r\n\r\n1. Faça um fork\r\n2. Crie sua branch para a funcionalidade (`git checkout -b nova-funcionalidade`)\r\n3. Faça o commit suas modificações (`git commit -am 'Adiciona nova funcionalidade'`)\r\n4. Faça o push para a branch (`git push origin nova-funcionalidade`)\r\n5. Crie um novo Pull Request\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstavarengo%2Fphp-sigep","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstavarengo%2Fphp-sigep","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstavarengo%2Fphp-sigep/lists"}