Roteiro de integração do eDocs

Esta documentação tem como objetivo fornecer um roteiro para o desenvolvimento de integração com o eDocs.

Saiba mais:

1. Requisitos e parametrizações
2. Tipos de integração
3. Leiautes e web services
4. Perguntas frequentes - FAQ

1. Requisitos e parametrizações

Cadastro de filial

Para que a integração ocorra corretamente, é necessário atender aos seguintes requisitos:

• O CNPJ da empresa/filial emissora dos documentos eletrônicos possua uma Licença válida do eDocs
• O CNPJ da empresa/filial emissora dos documentos eletrônicos esteja cadastrado no banco de dados do eDocs
• Possuir o cadastro do Certificado digital para atender aos processos dos documentos que exigem esta informação

Por exemplo, se existir uma empresa com o CNPJ XX. XXX. XXX/0001-XX e uma filial desta empresa com o CNPJ YY. YYY. YYY/0001-YY, onde a responsável pelas emissões das NF-es é a filial, então o CNPJ da filial deve estar cadastrado no banco de dados do eDocs para que a integração ocorra corretamente. Para cadastrar essas informações, verifique a documentação sobre Configurações de Empresas e Configurações de Filiais.

Parametrizações

Para que seja possível realizar a integração com o eDocs, as configurações abaixo devem ser realizadas:

• Monitor eDocs > Configuração > Gerais > Aba Integração > Seção Web service
  • O parâmetro Ativar web service de integração deve estar definido como Sim
  • O parâmetro Porta permitirá indicar em qual porta o eDocs disponibilizará os web services do eDocs
• Monitor eDocs > Configuração > Empresa > Aba Integração > Seção Web Service
  • Nos parâmetros Usuário e Senha deverão ser definidos usuário e senha para autenticação no web service do eDocs
• Monitor eDocs > Configuração > Filiais > Aba Filial > Aba Geral > Seção Integração
  • O parâmetro Forma de Integração (saída) deverá estar definido com o valor Desativar. Dessa forma, o eDocs não tentará efetuar retorno ao sistema emissor dos documentos após o documento estar em um status que permite realizar o retorno. O eDocs irá aguardar a consulta da situação do documento pelo próprio sistema emissor

  Importante

  • É recomendado que o eDocs seja reinicializado após a alteração das parametrizações
  • Caso o parâmetro Forma de Integração (saída), citado acima, não tenha sido definido como Desativar quando o documento foi emitido, será necessário configurar adequadamente o retorno no sistema emissor dos documentos para que esse retorno seja executado. Do contrário, no Log do eDocs sempre ficará sendo exibida mensagem de erro de retorno ao sistema emissor, havendo consumo desnecessário de recursos do servidor
  • Rotinas de web service que utilizam arquivos PDF/XML, principalmente .PDF, consomem mais recursos da máquina e precisam ser utilizados com cautela, pois não há uma limitação da quantidade de requisições que podem ser utilizadas ao mesmo tempo e a quantidade de recursos que as rotinas podem consumir do Servidor do eDocs, o que pode afetar diretamente a performance dos serviços disponibilizados no mesmo Servidor
  • Se houver a necessidade de utilizar os web services para um maior volume de requisições, orientamos que seja realizado um dimensionamento da infraestrutura do servidor baseado na volumetria das chamadas do web service realizadas por segundo/minuto. Você poderá utilizar um ambiente de homologação para fazer a análise e o acompanhamento das chamadas dos web services versus consumo de recursos do Servidor

Nota

Para que o processo de integração ocorra corretamente, é necessário atentar para os seguintes pontos de validação:

• Esta documentação aqui apresentada é baseada na versão de mercado mais recente do sistema, por isso é importante verificar se a versão da documentação dos web services que está sendo utilizada coincide com a versão do sistema instalado
• Caso a versão do sistema instalado seja diferente da versão da documentação dos web services aqui disponibilizada, será necessário atualizar o sistema eDocs para a versão de mercado mais recente ou utilizar a documentação que corresponda à versão do sistema instalado

2. Tipos de integração

O eDocs permite a integração através de web services síncronos ou assíncronos. Alguns documentos não possuem suporte para integração assíncrona. Segue abaixo uma tabela demonstrativa que apresenta as formas de integração disponibilizadas para cada tipo de documento eletrônico:

Documentos		Web service
		AutorizarDocumentos (síncrono)	IntegrarDocumento (assíncrono)
Federais / Estaduais	NF-e
	CT-e
	CT-e OS
	MDF-e
	eSocial
	NFC-e
	EFD Reinf
	PAF-ECF
	GNRE
	GRFGTS
	CF-e
	Recintos Aduaneiros
	Receituário Agronômico
	SISDEV
	IDAF
Municipais	NFS-e

3. Leiautes e web services

Ao realizar as etapas apresentadas acima e configurar a integração de emissões e recebimentos de NF-e, os web services do eDocs estarão ativos e operacionais. Abaixo, segue o detalhamento dos web services e leiautes que devem ser utilizados para realizar a integração:

Documentos	Leiaute	Operação	Tipo de integração	Web service utilizado
Federais/Estaduais (NF-e, CT-e, MDF-e, eSocial etc.)	XML padrão do governo	Emissão, Inutilização e Eventos (cancelamento etc.)	Síncrona	AutorizarDocumento
			Assíncrona	IntegrarDocumentos (envio)
				ConsultarSituacaoDocumentos (retorno)
		Recebimento	Síncrona	ConsultarRetornoRecebimento
			Síncrona	ConsultarSituacaoDocumentos
Municipais (NFS-e)	.XML padrão ABRASF 1.0 (com complemento InfSenior)	Emissão e Cancelamento	Síncrona	AutorizarDocumento
			Assíncrona	IntegrarDocumentos (envio)
				ConsultarSituacaoDocumentos (retorno)
Todos os documentos		Download .XML (Emissão)	Síncrona	BaixarXml
		Download .XML (Recebimento)	Síncrona	BaixarXmlv2
		Download .PDF	Síncrona	BaixarPdf
		Consultar críticas de integração por tipo de documento	Síncrona	ObterCriticasIntegracao
		Consultar críticas de integração por identificador	Síncrona	ObterCriticasPorIdentificador