Guia de Instalação

Índice

• Requisitos do Sistema
• Antes de Iniciar
• Métodos de Instalação
  • Instalação via Composer (Recomendado)
  • Instalação Manual
  • Instalação via Git
• Verificação da Instalação
• Solução de Problemas

Requisitos do Sistema

Antes de instalar o módulo Correios CWS, certifique-se de que seu ambiente atende ao seguinte requisito:

• Magento 2.4.x

Antes de Iniciar

É fortemente recomendável que você:

1. Faça um backup completo de sua loja e banco de dados antes de iniciar qualquer processo de instalação.
2. Realize a instalação em um ambiente de teste antes de implementar em produção.

Métodos de Instalação

Oferecemos três métodos de instalação para o módulo Sigep Web Carrier. Escolha o que melhor atende às suas necessidades.

Instalação via Composer (Recomendado)

O método mais seguro e recomendado para instalar o módulo é através do Composer, que garantirá a resolução automática de dependências.

composer require o2ti/sigep-web-carrier

Após a conclusão do download e instalação das dependências pelo Composer, execute os seguintes comandos para finalizar a instalação:

bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento setup:static-content:deploy -f
bin/magento cache:enable
bin/magento cache:flush

Instalação Manual

Se você preferir não usar o Composer, siga estas etapas para instalar o módulo manualmente:

1. Baixe o arquivo ZIP do módulo no repositório oficial
2. Descompacte o arquivo e copie todo o conteúdo para o diretório app/code/O2TI/SigepWebCarrier/ da sua instalação do Magento
3. Execute os seguintes comandos para ativar o módulo:

bin/magento module:enable O2TI_SigepWebCarrier
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento setup:static-content:deploy -f
bin/magento cache:enable
bin/magento cache:flush

Instalação via Git

Para desenvolvedores que preferem trabalhar diretamente com o repositório Git:

1. Navegue até a pasta app/code da sua instalação do Magento
2. Crie os diretórios necessários, caso não existam:

mkdir -p O2TI/SigepWebCarrier

3. Clone o repositório:

git clone https://github.com/o2ti/sigep-web-carrier.git O2TI/SigepWebCarrier

4. Execute os comandos para ativar o módulo:

bin/magento module:enable O2TI_SigepWebCarrier
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento setup:static-content:deploy -f
bin/magento cache:flush

Verificação da Instalação

Para verificar se o módulo foi instalado corretamente:

1. Acesse o painel administrativo do Magento
2. Navegue para Vendas > Correios CWS > Gerenciamento de PPN (antiga PLP)
3. Se você conseguir visualizar a página de gerenciamento, o módulo está instalado corretamente

Alternativamente, você pode verificar via linha de comando:

bin/magento module:status O2TI_SigepWebCarrier

O resultado deve mostrar o módulo como habilitado.

Solução de Problemas

Erros Comuns e Soluções

Erro	Solução
Exceção durante o setup:upgrade	Verifique as permissões de arquivo
Módulo não aparece no Admin	Limpe os caches e verifique se o módulo está habilitado
Erro de conexão com os Correios	Verifique suas credenciais e se o ambiente dos Correios está funcionando
Erro de compilação	Verifique conflitos com outros módulos instalados