Gerenciamento de Empresas na API Rest

A Configuração de uma Empresa através da API Rest será permitido para o usuário que já possuir o x-auth-token. No artigo Autenticação na API Rest damos mais detalhes sobre o x-auth-token. Existem alguns Endpoints para a configuração do serviço e para cada um, há uma URL específica.

 

Configuração de Empresas

Pela Api Rest o usuário poderá consultar, ativar, desativar e parametrizar uma empresa.

Importante ressaltarmos que a liberação sempre que ativado ou desativado uma empresa, é necessário informar a Oobj para que sejam feitas as liberações das credenciais necessárias  para os serviços utilizados.

 

 Adição de empresas (POST)

Nesse Endpoint, é possível cadastrar uma nova empresa, para iniciar a utilização da aplicação.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/empresas

 

Na requisição deverão passar as seguintes informações:

  • Chave de Ativação: Informação passada pela Oobj após a liberação;
  • Consulta Síncrona (True/False): Se a comunicação com a Sefaz é Síncrona ou Assíncrona;
  • CPF/CNPJ: CPF ou CNPJ da empresa a cadastrar;
  • Município: Município da Empresa;
  • Nome Exibição: Nome Fantasia da Empresa;
  • Razão Social: Razão social da Empresa;
  • UF: Estado da Empresa;

 

Exemplo:

http://rest.oobj-dfe.com.br/api/empresas

 

 Alterar tipo de Emissão de uma empresa (POST)

Nesse Endpoint, é possível configurar o tipo de emissão de uma empresa. Podendo ser utilizado por exemplo para ativar a contingência e voltar as emissões para normal.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/{codModelo}/{tpEmis}

 

Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:

 

  • {empresa} : CNPJ da Empresa
  • {codModelo}: Código do Modelo do documento (55, 65, 57 etc);
  • {tpEmis}: O Tipo de emissão que deve utilizar (1, 2, 3 etc)

 

Exemplo:

http://rest.oobj-dfe.com.br/api/empresas/07385112358746/55/1

 

 

Upload de Certificado (POST)

Nesse Endpoint, é possível configurar o certificado digital (A1), para que a empresa possa emitir e/ou receber documentos. Utilizado também para atualizar certificados vencidos.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/certificado

 

Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:

 

  • {empresa}: CNPJ da Empresa

 

Exemplo:

http://rest.oobj-dfe.com.br/api/empresas/07385112358746/certificado?senha=12345624&tipoCertificado=PKCS12

 

Configurar Conta de Email para Recebimento (POST)

Nesse Endpoint, é possível configurar uma conta de e-mail para que a aplicação monitore os e-mails recebidos e baixe os XMLs dos documentos fiscais eletronico. 

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/recebimento

 

Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:

  • {empresa}: CNPJ da Empresa

 

Os parâmetros a serem enviados junto com a requisição são:

  • {ativo}: Informa que a consulta está ativa (true);
  • {porta}: porta de conexão com o servidor de e-mail;
  • {senha}: senha utilizada para acessar a conta do e-mail;
  • {servidor}: passar informações do host do servidor;
  • {tipoConexao}: informar o tipo de conexão do servidor (IMAP ou POP3);
  • {usarSsl}: utilizará a configuração SSL (true ou false);
  • {usuario}: usuário utilizada para acessar a conta do e-mail;

 

Exemplo:

http://rest.oobj-dfe.com.br/api/empresas/07385112358746/recebimento

 

Configurar SMTP para envio de e-mails (POST)

Nesse Endpoint, é possível configurar uma conta de e-mail para que ao emitir um documento e esteja configurado para enviar e-mail para o destinatário utilize o próprio servidor de e-mails ao invés do Oobj.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/smtp

 

Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:

  • {empresa}: CNPJ da Empresa

 

Os parâmetros a serem enviados junto com a requisição são:

  • {ativo}: Informa que a consulta está ativa (true);
  • {porta}: porta de conexão com o servidor de e-mail;
  • {protocolo}: informar o tipo de conexão do servidor (IMAP);
  • {remente}: remetente utilizada na conta do e-mail;
  • {senha}: senha utilizada para acessar a conta do e-mail;
  • {servidor}: passar informações do host do servidor;
  • {usuario}: usuário utilizada para acessar a conta do e-mail;

 

Exemplo:

http://rest.oobj-dfe.com.br/api/empresas/07385112358746/smtp

 

Gerar Chave AC para SAT-CFE (GET)

Nesse Endpoint, é possível gerar a chave AC (Assinatura do Contribuinte) para vincular junto ao aparelho SAT e iniciar a emissão de CF-e.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/chave-ac

 

Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:

  • {empresa}: CNPJ da Empresa

  

Exemplo:

http://rest.oobj-dfe.com.br/api/empresas/07385112358746/chave-ac

 

Retornar informações do Certificado Digital de uma Empresa (GET)

Nesse Endpoint, é possível puxar as informações do certificado de uma empresa. Comumente utilizado para validar se o certificado está vencido ou próximo do vencimento.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /api/empresas/{empresa}/certificado

 

Os valores sublinhados devem ser substituídos pelos valores correspondentes abaixo:

  • {empresa}: CNPJ da Empresa

  

Exemplo:

http://rest.oobj-dfe.com.br/api/empresas/07385112358746/certificado

 

 

Os Endpoints listados nesse artigo são os essenciais e para realizar o cadastro de uma empresa na Aplicação da Oobj. Para saber ter acesso a todos os parâmetros, acesse o seguinte link: Configuração de Empresa.

0 (0)
Avaliação do Artigo (Nenhum voto)
Avaliar esse artigo
Anexos
Não há anexos para este artigo.
Artigos Relacionados RSS Feed
Manutenção de CSC (Código de Segurança do Contribuinte) na API Rest
Visualizado 2329 vezes desde 16/03/2018
Emissão de Eventos Fiscais na API Rest
Visualizado 2298 vezes desde 16/03/2018
Consulta Cadastro Centralizado de Contribuinte - Consulta Cadastro API Rest
Visualizado 626 vezes desde 14/01/2021
Consultar MDF-e não encerrado via API Rest
Visualizado 111 vezes desde 23/08/2021
Importação e Conciliação de DFes na API Rest
Visualizado 1559 vezes desde 16/03/2018
Geração de chave AC (Assinatura do Contribuinte) para SAT na API Rest
Visualizado 4198 vezes desde 26/12/2019
Como funciona o processo de emissão na API Rest?
Visualizado 2049 vezes desde 06/08/2019
API REST: Ano contido no documento não é o mesmo do informado no serviço - Como resolver?
Visualizado 1179 vezes desde 08/01/2019
Inutilização de Numeração na API Rest
Visualizado 2197 vezes desde 16/03/2018
Consultar Base de Conhecimento (BC) via API Rest
Visualizado 85 vezes desde 03/08/2021
Comentários
Nome
Email
Código de Segurança Security Code
Não há comentários para este artigo. Seja o primeiro a postar um comentário.