Como configurar uma conta de e-mail para receber DFes?

Caso tenha interesse que a aplicação monitore e-mails recebidos e baixe os XMLs dos Documentos Fiscais Eletrônicos (DFes), é necessário cadastrar uma conta de e-mail.

Confira os detalhes abaixo.

---

Envie uma requisição de configuração de conta

1. Para começar, faça uma requisição tipo POST ao endpoint configurar conta de e-mail de recebimento;

   [URL_BASE]/api/empresas/{empresa}/recebimento

2. Preencha as seguintes informações (path parameters):

   • {empresa}*: CNPJ da empresa.

3. No corpo da requisição (request body) preencha os seguintes parâmetros:

   • {ativo}: true ou false;
   • {porta}: porta de conexão com o servidor de e-mail;
   • {senha}: senha do e-mail ou usuário de acesso ao servidor de e-mail;
   • {servidor}: endereço do servidor de e-mail;
   • {tipoConexao}: IMAP ou POP3;
   • {usarSsl}: true ou false;
   • {usuario}: e-mail ou usuário de acesso ao servidor de e-mail.

Atenção

Se o parâmetro {ativo} for verdadeiro (true), todos os parâmetros do corpo de requisição (request body) tornam-se obrigatórios. Caso contrário ({ativo}: false), os parâmetros não serão armazenados. Após feita a primeira requisição de configuração com os parâmetros acima, é possível preencher parâmetros isolados.

4. Informe o x-auth-token no cabeçalho (header parameters) da requisição.

Outras configurações

Os seguintes parâmetros são aqueles que dependem um habilitar ou não certa função.

5. Por padrão, todos os parâmetros abaixo iniciam como false.:

• Habilitar protocolo de segurança criptografado
  • {habilitarSegurancaCriptografada}: true ou false;
  • Obrigatório um OU outro caso o parâmetro "habilitarSegurancaCriptografada" for true:
    • {usarSsl}: true ou false;
    • {usarTls}: true ou false;

• Tipo de Autenticação (Simples ou MFA)
  • Para usar autenticação simples, basta ter informado o campo {senha} descrito anteriormente
  • Para usar autenticação MFA, informe um objeto {mfa} composto pelos seguintes campos:
    • {clientId}: String
    • {clientTenantId}: String
    • {secret}: String

info

• Só pode ser informado apenas um dos tipos de autenticação
• Caso seja informado os dois, será considerado a autenticação simples (parâmetro {senha})

• Habilitar recebimento de NFSe

  • {habilitarRecebimentoNfse}: true ou false;
  • Obrigatório um OU outro caso o parâmetro "habilitarRecebimentoNfse" for true:
    • {emailRecebimento}: String
    • {apiRecebimento}: String

• Pasta monitorada

  • {monitorarOutraPasta}: true ou false;
  • Caso o parâmetro "monitorarOutraPasta" for true, deve ser informado o caminho da pasta em "outraPasta":
    • {outraPasta}: String

• Habilitar monitoramento de espaço em conta

  • {habilitarMonitoramentoEspacoConta}: true ou false;
  • Obrigatório informar todos o seguintes parâmetros caso o "habilitarMonitoramentoEspacoConta" for true:
    • {emailNotificacao}: String
    • {percentualMaximoUsoConta}: Integer
  • {diasParaManterEmailCaixaEntrada}: Integer

• Testar conexão

  • {testarConexao}: true ou false;

    info

    Caso seja true, será retornado o resultado do teste de conexão com base nas configurações informadas

Exemplo de requisição

O exemplo abaixo traz um modelo de requisição preenchido para configuração de uma conta de e-mail.

Observação

A requisição contém dados fictícios, somente para demonstração.

curl -L -X POST 'https://rest-teste.oobj.com.br/api/empresas/07385111000102/recebimento' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'x-auth-token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI3Yjc2OTg1ZGQ2MTNhOWVlYTFiN2RmZTNiZjRhMTRiZiIsImF1ZCI6IndlYiIsImV4cCI6MTYyOTI5MDcwNiwiaWF0IjoxNjI5Mjg4OTA2fQ.-Dj91d6fBZYcZpy1-zKzohAWd5dgW2CAS5BBfwGilemUYcOVDm8CnrDJHbwsFyixI5ohphy-65fqeobXkimtCg' \
--data-raw '{
  "ativo": true,
  "porta": 993,
  "senha": "pass123",
  "servidor": "imap.gmail.com",
  "tipoConexao": "IMAP",
  "habilitarSegurancaCriptografada": true,
  "usarSsl": true,
  "habilitarRecebimentoNfse": true,
  "emailRecebimento": "mail@example.com",
  "monitorarOutraPasta": true,
  "outraPasta": "RECEBIMENTO",
  "habilitarMonitoramentoEspacoConta": true,
  "emailNotificacao": "mail@example.com",
  "percentualMaximoUsoConta": 50,
  "diasParaManterEmailCaixaEntrada": 30,
}'

Exemplo de retorno

{

}

Pronto! Você acaba de completar a configuração de uma conta de e-mail para o recebimento de DFes.