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.

Nº do Artigo: 749
Postado: 16/03/2018 10:26:11
Última atualização: 20/09/2021 12:01:16
Postado: Isabel Cavalcanti [isabel.cavalcanti@oobj.com.br]

URL: https://backupbc.novooobj.xyz/article/gerenciamento-de-empresas-na-api-rest-749.html