MODO
A rota modo será utilizada para verificarmos as configurações de um CNPJ ou realizar a alteração de alguma das informações do mesmo.
Podemos executar comandos para consultar as configurações, informações sobre os certificados e alterar propriedades de configuração.
A maioria dos comandos e propriedades também se aplicam aos clientes que utilizam o Manager SaaS.
Os comandos que podem ser realizados são:
| Campo | Valor | Descrição | Exemplo |
| GetConfig | 1 | Retorna o arquivo de configurações do CNPJ | GetConfig=1 ou GetConfig |
| GetVencimentoCertificado |
1
|
Retorna a data e hora do vencimento do certificado configurado no CNPJ | GetVencimentoCertificado=1 ou GetVencimentoCertificado |
| GetCertificados | 1 |
Retorna o nome de todos os certificados instalados na máquina onde o Manager EDoc está sendo executado. Atenção!: Somente para Manager EDoc |
GetCertificados=1 ou GetCertificados |
Os campos disponíveis para configuração estão divididos em seções para melhor organização (MANAGEREDOC, CTEOS, DACTE, MAIL e NOTASEGURA), seguem abaixo:
MANAGEREDOC
Abaixo seguem as propriedades da seção MANAGEREDOC que podem ser alteradas:
| Campo | Descrição | Valor |
| FieldDelimiter | Delimitador de campos | Por padrão | |
| LineDelimiter | Delimitador de linha | Por padrão delimitador de quebra de linha do Windows ("Enter"). |
| AutoEmail | Envio de e-mail automático ao final da autorização da CT-e OS. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
| AutoImprimir | Impressão do Dacte ao final da autorização do CT-e OS. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
| AutoXmlDestinatario | Geração do XML do CT-e OS. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
| RemoveCaracterXml | Remove caracteres especiais do XML do CT-e OS antes da assinatura. | 1 - Habilita ou 0 - Desabilita |
| Modo | Modo de envio do CT-e OS. |
NORMAL, FSDA, SVCRS, SVCSP ou EPEC |
| NomeSecaoManager | Indica o nome da seção no arquivo .ini onde estão as configurações do EDoc. | Por padrão nome da seção é MANAGEREDOC |
| NumeroAutomatico | Numeração automática do CT-e OS. |
Por padrão 1 1 - Habilita ou 0 - Desabilita |
| QtdeCopias | Quantidade de cópias do Dacte a serem impressas. | Por padrão 1 |
| ServerDelay | Tempo de espera antes de executar a comunicação com o servidor da SEFAZ. | Por padrão 5000 (em milissegundos) |
| TimeOut |
Tempo máximo de espera da resposta de uma requisição feita a SEFAZ. |
Por padrão 60000 (em milissegundos) Atenção! Existe campo com mesmo nome em outra seção, caso queira alterar apenas nessa seção deve-se informar o nome da seção antes do campo. |
| QtdeTentativas | Quantidade máxima de tentativas do envio do CT-e OS. | Por padrão 10 |
| ToleranciaStandBy | Tolerância do número de requisições para o WebService que resultaram em falha de alguma natureza. | Por padrão 10 |
| TempoStandBy | Tempo em que o Manager EDoc permanecerá em StandBy. |
Por padrão 300 (em segundos) Valor mínimo 60 |
| NumeracaoDescartada | Reutilização da numeração das notas descartadas. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
| TimerResolvePendencias | Tempo em segundos para inicio do resolve automático. | Por padrão 0 |
| EnviarEmailEvento | Envia o e-mail dos eventos vinculados ao CT-e OS. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
| EnviarNotaAutomaticamente | Envia automaticamente o CT-e OS para o Plug Storage logo após a autorização. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
| UsaLineDelimiter | Habilita ou desabilita o uso de delimitador de linha. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
| AutoimprimirCCe |
Impressão da carta de correção logo após autorização. |
Por padrão 0 1 - Habilita ou 0 - Desabilita |
| Serie |
Série de numeração cadastrada no CNPJ do Emitente. |
Valor da série (Inteiro). |
| NumeroInicial ou NumInicialNF |
Número inicial da série. |
Valor do número inicial (Inteiro). Atenção! Para alterar o número inicial de uma determinada série, deve ser utilizada na rota os campos serie e numeroinicial em conjunto. |
| UseSecureBlackBox |
Envio de email pelo UseSecureBlackBox |
TRUE ou FALSE Atenção! Por padrão FALSE, habilitar para TRUE somente quando o cliente tiver problemas de autenticação de email. |
| DiretorioDaCTeOS |
Diretório onde está localizado o layout de impressão do CT-e OS. Observação: O caminho depende da versão do esquema configurada. |
Por padrão na pasta de instalação. Exemplo: C:\Program Files (x86)\Manager eDoc\Plugins\ManagerCTeOS\Files\Templates\3.00a\DACTE |
| ImpressoraPadrao | Indica a impressora padrão para a impressão do DACTE do CT-e OS. | Por padrão a impressora definida como padrão do windows. |
| ModoImpressao | Indica a forma de impressão do DACTE do CT-e OS. |
Por padrão "PDF". Impressora: Imprime na impressora configurada. PDF: Gera o DACTE em arquivo .pdf. Ambos: Imprime na impressora configurada e gera o arquivo .pdf. |
| ControleStandBy | Indica a forma como o Manager EDoc vai controlar a entrada em StandBy. | Por padrão "CNPJ". (Atualmente só existe essa forma de controle de standby). |
| CancelamentoEvento | Se utiliza Cancelamento por Evento. |
Por padrão 1 1 - Habilita ou 0 - Desabilita |
CTEOS
Abaixo seguem as propriedades da seção CTEOS que podem ser alteradas:
| Campo | Descrição | Valor |
| UF |
Unidade Federativa (Estado) do Emitente. |
|
| Repositorio | Define o tipo do certificado que será utilizado | MEMORY_STORE, LOCAL_MACHINE_STORE, CURRENT_USER_STORE, ACTIVE_DIRECTORY_USER_STORE ou SMART_CARD_USER_STORE |
| NomeCertificado | Nome do Emitente para qual foi emitido o certificado | |
| PinCode | Senha do Certificado A3 | Ex:Senha123 |
| ArquivoServidoresHom | Configurar onde encontra-se o arquivo cteosServidoresHom.ini que contém os endereços dos webservices de Homologação. | cteosServidoresHom.ini |
| ArquivoServidoresProd | Configurar onde encontra-se o arquivo cteosServidoresProd.ini que contém os endereços dos webservices de Produção. | cteosServidoresProd.ini |
| ModoOperacao | Modo de envio do CT-e OS. |
NORMAL, FSDA, SVCRS, SVCSP ou EPEC |
| DiretorioLog | Diretório onde serão criados os arquivos de log | "Plugins\ManagerCTeOS\Files\Log" |
| Ambiente | Ambiente onde será realizado o envio |
1 - Produção |
| VersaoManual | Versão dos schemas da Sefaz | 3.00, 3.00a ou 4.00 |
| MaxSizeFileEnvio | Limite para o tamanho de arquivo que será enviado. | 500 |
| DiretorioXmlTomadorServico | Diretório onde os XMLs autorizados serão gerados | "Plugins\ManagerCTeOS\Files\XmlTomadorServico" |
| DiretorioEsquemas | Diretório dos Esquemas XML | "Plugins\ManagerCTeOS\Files\Esquemas" |
| DiretorioTemplates | Diretório dos Templates que serão utilizados na geração dos arquivos XML | "Plugins\ManagerCTeOS\Files\Templates" |
| AnexarDactePDF | Ao enviar o XML de distribuição para o Tomador de serviço |
Por padrão 1 1 - Habilita ou 0 - Desabilita |
| Proxy | Propriedade que permite colocar o endereço do Proxy para conectar a internet. | IP do proxy |
| Usuario |
Nome do usuário do proxy. |
Atenção! Existe campo com mesmo nome em outra seção, caso queira alterar apenas nessa seção deve-se informar o nome da seção antes do campo. |
| Senha |
Senha do usuário do proxy. |
Atenção! Existe campo com mesmo nome em outra seção, caso queira alterar apenas nessa seção deve-se informar o nome da seção antes do campo. |
| ValidarEsquema ou ValidarAntesDoEnvio | Propriedade que permite ativar ou desativar a validação de esquema antes do envio |
1 - Habilita ou 0 - Desabilita |
| ConexaoSegura | Para quando o servidor utilizar conexão segura onde é exigido o certificado digital. |
|
| TimeOut |
Tempo de espera de resposta do WebService (valor em milisegundos). |
60000 Atenção! Existe campo com mesmo nome em outra seção, caso queira alterar apenas nessa seção deve-se informar o nome da seção antes do campo. |
| IgnoreInvalidCertificates | Ignora mensagens de erro sobre certificados inválidos |
|
| HttpLibs |
Indica se o componente irá utilizar os recursos do Windows ou recursos internos para efetuar a comunicação com a Sefaz |
wininet: a comunicação é feita com recursos do Windows sbb: a comunicação é feita com recursos do próprio componente Padrão: wininet,sbb |
DACTE
Abaixo seguem as propriedades do seção DACTE que podem ser alteradas:
| Campo | Descrição | Valor |
| FraseContingencia | Indica a frase que será impressa no DACTE quando o CT-e OS for emitida em modo de Contingência. | Exemplo: "DACTE em contingência - Impresso em decorrência de problemas técnicos." |
| FraseHomologacao | Indica a frase que será impressa no DACTE quando o CT-e OS for emitida em Ambiente de Homologação. | Exemplo: "SEM VALOR FISCAL" |
| ModeloRetrato | Aponta para o diretório onde está o arquivo RTM com Layout de impressão em Retrato. | Exemplo: "Plugins\ManagerCTeOS\Files\Templates\3.00a\DACTE\retratoCteOS.rtm" |
| ModeloPaisagem | Aponta para o diretório onde está o arquivo RTM com Layout de impressão em Paisagem. | Exemplo: "Plugins\ManagerCTeOS\Files\Templates\3.00a\DACTE\paisagemCTeOs.rtm" |
| LogotipoEmitente | Propriedade onde permite-se configurar o Logo do Emitente no DACTE. |
Por padrão vazio. Exemplos: C:\logo.png ou C:\logo.jpeg. |
| ModeloRTMCCe | Aponta para o diretório onde está o arquivo RTM com Layout de impressão da carta de correção. | Exemplo: "\Templates\cce\Impressao\modeloCCe.rtm" |
Abaixo seguem as propriedades do seção MAIL que podem ser alteradas:
| Campo | Descrição | Valor |
| Servidor | Endereço do servidor de envio de email (SMTP/SMTPS). | smtp.gmail.com |
| EmailRemetente | Email para o qual será enviada o CT-e OS | teste@tecnospeed.com.br |
| Assunto | Assunto do e-mail | Você recebeu um Conhecimento de Transporte eletrônico |
| Mensagem | Corpo da mensagem que será enviada por e-mail. | Os arquivos referentes ao Conhecimento de Transporte eletrônico foram anexados a este email. |
| AssuntoCancelamento | Assunto do e-mail do evento de cancelamento | Olá, em anexo está o XML do cancelamento do seu CT-e OS. |
| MensagemCancelamento | Corpo da mensagem do evento de cancelamento que será enviada por e-mail. | Olá, em anexo XML do evento de cancelamento do seu CT-e OS. |
| Usuario |
Usuário de autenticação do servidor de e-mail. |
Atenção! Existe campo com mesmo nome em outra seção, caso queira alterar apenas nessa seção deve-se informar o nome da seção antes do campo. |
| Senha |
Senha do E-mail. |
123mudar Atenção! Existe campo com mesmo nome em outra seção, caso queira alterar apenas nessa seção deve-se informar o nome da seção antes do campo. |
| TimeOut |
Tempo de espera de envio de E-mail (Milissegundos). |
60000 Atenção! Existe campo com mesmo nome em outra seção, caso queira alterar apenas nessa seção deve-se informar o nome da seção antes do campo. |
| EmailDestinatario | Email para o qual será enviada o CT-e OS. | destinatario@exemplo.com |
| CCo | Email para o qual a mensagem será enviada em cópia oculta. | cco@exemplo.com |
| CC | Email para o qual a mensagem será enviada em cópia. | cc@exemplo.com |
| Autenticacao | Propriedade booleana que deve ser ativada quando o servidor de e-mail exigir autenticação. | True ou False |
| Porta | Porta de conexão com o servidor de SMTP/SMTPS necessária para envio de e-mail. | 587 |
| ConteudoHtml | Define o formato do texto do corpo do e-mail. |
0 - Indica que o corpo da mensagem não contém um conteúdo HTML 1 - Indica que o corpo da mensagem contém um conteúdo HTML |
| QtdeTentativasEmail | Quantidade máxima de tentativas de envio do e-mail em caso de falha. | 5 |
| TipoTLS | Tipo de protocolo TLS utilizado no envio de e-mail. |
Por padrão REQUIRETLS Valores possíveis: REQUIRETLS IMPLICITTLS EXPLICITTLS |
| AssuntoDestinatario | Assunto do e-mail destinatário |
|
| MensagemDestinatario | Corpo da mensagem que será enviada por e-mail. |
|
| Provedor | Provedor de e-mail |
gmail |
NOTASEGURA
Abaixo seguem as propriedades do seção NOTASEGURA que podem ser alteradas:
| Campo | Descrição | Valor |
| NotaSeguraServidor | Endereço do servidor PlugStorage | |
| NotaSeguraLogin | Login do usuário no PlugStorage. | |
| NotaSeguraSenha | Senha do usuário no PlugStorage. | |
| NotaSeguraToken | Token do usuário no PlugStorage |
GET
http://localhost:8081/ManagerAPIWeb/cteos/modo
Headers
| Nome | Descrição | Exemplo |
| Authorization | Este usuário e senha são os seus dados para logar como administrador em um grupo do EDoc | Basic dGVzdGU6MTIzbXVkYXI= |
Querystring
| Nome | Descrição |
| Grupo | Nome do grupo |
| CNPJ | CNPJ do emitente do CT-e OS cadastrado no Manager EDoc, apenas números |
| Secao |
MANAGEREDOC ou CTEOS ou MAIL Opcional - Informar a seção principalmente ao alterar campos com mesmo nome em seções diferentes, por exemplo Usuario, Senha e Timeout. Para alterar campos únicos não é necessário informar a seção. |
| Comando ou Campo |
Valor do comando desejado, exemplo: GetVencimentoCertificado=1 |
Retorno
Será de acordo com o comando ou campo informado.
Exemplo de retorno com os campos (ValidarEsquema=1) :
OK, Operação realizada com sucesso
Exemplo de retorno (GetVencimentoCertificado=1) :
03/05/2022 13:34:00
Comentários
0 comentário
Por favor, entre para comentar.