Entendendo os envios para o PlugNotas

Você deve ter visto na documentação do Swagger que o PlugNotas possui duas URLs distintas: uma para o ambiente Sandbox e outra para a API Oficial. Nesta seção, explicamos a finalidade de cada uma e quando utilizá-las.

Sandbox

O Sandbox é um ambiente de testes simulado (mock), ou seja, todas as requisições feitas nesse ambiente são processadas apenas nos nossos servidores, com retornos pré-definidos. Nenhuma requisição é enviada aos servidores da prefeitura ou SEFAZ.

As rotas de cadastro de empresas e certificados retornam exatamente os dados enviados. Já as rotas relacionadas a notas fiscais (envio, cancelamento, impressão) sempre devolvem respostas padronizadas e simuladas.

Quando usar o Sandbox?

• Ideal para quem ainda está avaliando a contratação do PlugNotas e não possui token de autenticação. Permite realizar testes iniciais e compreender como a API funciona.
• Recomendado para testes de cadastro de empresas e certificados, pois retorna exatamente os dados enviados, evitando incluir informações fictícias na API oficial.

Observações Importantes

• O ambiente SandBox não possui uma interface para acesso, as consultas deverão ocorrer através das rotas disponíveis em nossa documentação.
• Os retornos das rotas de nota fiscal são sempre mockados. O conteúdo da resposta pode não refletir a requisição enviada.
• Nem todas as rotas estão completamente disponíveis no Sandbox. Por exemplo, não é possível testar o fluxo completo de Webhook; apenas algumas etapas como envio e verificação retornam dados simulados.

API Oficial

Esta é a API utilizada em ambiente real, ou seja, todas as requisições são de fato processadas pela prefeitura ou SEFAZ. Os retornos refletem exatamente o status das notas fiscais enviadas.

Ao cadastrar uma empresa emitente (você ou seu cliente), é possível escolher entre os ambientes de homologação e produção. No modo homologação, as notas são transmitidas aos órgãos oficiais, mas não geram tributos. Quando tudo estiver validado, basta alterar para produção.

Quando usar a API Oficial?

• Indicada para testar o envio real das notas, proporcionando um cenário idêntico ao ambiente de produção.
• É a API que deve ser utilizada quando seu sistema estiver pronto para operar com clientes em ambiente de produção.

Observações

• Empresas cadastradas na API oficial não podem ser removidas. Em caso de erro, é necessário inativá-las.
• Notas fiscais também não podem ser excluídas após o envio.
• O teste completo de Webhook deve ser feito na API oficial, pois esse recurso não está disponível no ambiente Sandbox.

< Anterior Próximo >