APIs ConexãoNF-e

Neste artigo você poderá conhecer todas as APIs do ConexãoNF-e, sua documentação técnica e como agendar uma reunião com a equipe técnica.

As APIs externas disponibilizadas pelo ConexãoNF-e, tornam possíveis as integrações nas quais não fazemos de forma direta através dos integradores. Com isso qualquer sistema, através de um desenvolvimento para consumi-las, pode acessar algumas funcionalidades disponíveis no Conexão.

Link da documentação técnica:

Documentação técnica de APIs ConexãoNF-e

Ao final deste documento você poderá agendar uma reunião diretamente com a equipe técnica de desenvolvimento do ConexãoNF-e, mas antes confira a descrição de todas nossas APIs de forma detalhada. 



Autenticação

Para se autenticar, basta logar no portal e pegar o ID de integração disponível no menu “Administrar” depois “Usuários”, nessa tela constam todos os usuários cadastrados, então basta clicar no ícone da imagem a seguir e depois na opção “editar". 

1-Sep-27-2023-11-51-48-5751-AM

Feito isso, basta gerar um ID de Integração se ainda não o tiver, ou copiar se o mesmo já estiver gerado.

2-Sep-27-2023-11-51-48-7051-AM

Depois, com o ID de integração em mãos, basta seguir nossa documentação técnica para realizar a chamada da API de Autenticação e gerar o token que será passado nas requisições.

API Extração de dados e XML (DFe)

Essa API nos trás grandes possibilidades como:

  • Fazer o download de todos o XMLs de documentos fiscais (NF-e, CT-e, NFS-e, NFC-e), bem como todos os XMLs dos eventos registrados (Manifestos, Carta de Correção e etc), de todos os estabelecimentos cadastrados na conta e com isso manter uma base de documentos sempre atualizada.

  • Baixar todos os XMLs de algum estabelecimento (CNPJ/CPF) específico.

  • Baixar o XML de algum documento específico.

  • Baixar o XML de evento (Manifestos) de alguma NF-e específica.

  • Permite verificar o status de algum documento.

  • Obter informações básicas de um documento.

  • Obter informações detalhadas vindas do XML do documento.

API Geração de DANFE

Essa API disponibiliza no formato PDF o documento auxiliar (DANFE, DANFCE, DACTE e DANFSE) dos documentos fiscais. Na nossa documentação técnica constam os parâmetros necessários para a sua utilização.

API Estabelecimentos

API utilizada para fazer a gestão dos estabelecimentos da conta, através dela é possível listar os estabelecimentos cadastrados, adicionar novos CNPJs, editar as informações de algum estabelecimento cadastrado e remover algum caso necessário.

API Certificados

Nessa API, é possível listar os certificados e ver quais estabelecimentos são vinculados a ele, também é possível adicionar ou remover certificados digitais A1. O vínculo do certificado ao estabelecimento é feita de maneira automática através da raiz do CNPJ.

API Capturas

O propósito dessa API é visualizar o status de captura dos estabelecimentos. Depois de cadastrar o estabelecimento e o certificado digital, é através dela que é feita a ativação ou desativação da captura de documentos fiscais.

API Marcadores e Marcador Documento

Uma função muito utilizada pelos usuários do Conexão-NFe é a possibilidade de adicionar marcadores personalizados aos documentos, na API Marcadores é possível listar todos os marcadores cadastrados de acordo com cada tipo de documento (NF-e emitidas, recebidas e transportadas, CT-e recebido e envolvido, NFS-e recebidas, NFC-e emitidas e CT-e OS).

Na API Marcador Documento, o intuito é verificar quais marcadores estão vinculados a um documento específico e também vincular ou desvincular os marcadores aos documentos fiscais.

API Flag ERP

Nessa API é possível verificar se o documento está lançado ou não no ERP, e também sinalizar para o Conexão se o documento foi lançado ou cancelado.

API NFe

NF-e Recebidas Consulta Chave de Acesso: Essa API tem o objetivo de retornar as chaves de acesso de NFe Recebidas, com ela é possível listar as chaves de acesso através de uma data inicial e uma data final, com essas chaves em mãos o usuário consegue usufruir de outras APIs que necessitam das chaves como parâmetro.

 


 

Agendando uma reunião com a equipe técnica do ConexãoNF-e 

Disponibilizamos alguns horários para proporcionar o melhor atendimento possível aos clientes do ConexãoNF-e. Para agendar uma reunião, é importante seguir algumas orientações:

  1. Certifique-se de que haverá um representante técnico (desenvolvedor) da sua empresa presente nesta reunião.
  2. Faça uma revisão da documentação técnica. Toda a informação sobre usabilidade e arquitetura de nossas APIs encontra-se detalhada nesse documento: Documentação técnica de APIs ConexãoNF-e
  3. Registre suas dúvidas no formulário fornecido. Dependendo da natureza da dúvida, um profissional especializado será designado para auxiliá-lo.
  4. Para agendar a reunião com a equipe responsável, envie e-mail para matheus.schmitt@arquivei.com.br com o assunto: API ConexãoNF-e + nome da sua empresa.