Administração de Aplicativo

Esta transação cadastra aplicativos, usados para conectar outros sistemas ao CobranSaaS. A tela de configuração (Administração Administrar Aplicativo) tem duas partes: um filtro para buscar e gerenciar aplicativos cadastrados, e o botão Novo Aplicativo para cadastrar um novo, sem precisar usar o filtro.

Ao clicar no botão Novo Aplicativo, o usuário será direcionado a tela de detalhe na qual será possível preencher os seguintes campos:

- Nome: nome de identificação do aplicativo.

- Situação: situação do aplicativo.

- Código: código do aplicativo. Este é um dos campos utilizados na autenticação do aplicativo.

- Assessoria: se o aplicativo está vinculado a alguma assessoria de cobrança.

- Restrição de IP: restringir acesso ao sistema deste aplicativo a determinados IPs ou range de IPs.

- Agrupador: são os agrupadores vinculados a este aplicativo, ou seja, o aplicativo poderá visualizar somente os clientes vinculados aos mesmos agrupadores aqui selecionados. Para selecionar os agrupadores, clicar sobre o número de agrupadores selecionados (por exemplo, “3 selecionado(s)”). Após o clique, o usuário será direcionado a uma modal para seleção de agrupadores. Se o usuário selecionar o cadastro de uma assessoria (campo Assessoria), este campo fica oculto, visto que as assessorias sempre possuem acesso à carteira distribuída, independente do agrupador do cliente.

- Oauth2 - Tipos de Concessão: o tipo de concessão para solicitar a autorização. Opções disponíveis: Password, Authorization Code, Refresh Token e Client Credentials.

- Oauth2 - Validade Access Token: tempo de validade (em segundos) para o access token.

- Oauth2 - Validade Refresh Token: tempo de validade (em segundos) para o refresh token.

- Oauth2 - URL Redirecionamento: o serviço irá redirecionar o usuário depois de autorizar/negar a aplicação para a URL cadastrada neste campo.

- Permissões de Acesso: permissões de acesso para o aplicativo por API. Se o usuário selecionar o cadastro de uma assessoria (campo Assessoria), as permissões ficam ocultas, visto que o sistema já vincula às permissões necessárias para uma assessoria.

APIs disponíveis para seleção de permissão:

Acordos

- /acordos - GET: método para consultar acordos.

- /acordos/efetivar - POST: método para efetivar acordos.

- /acordos/simular - POST: método para simular acordos.

- /acordos/{id} - GET/DELETE: métodos para consultar e cancelar um acordo específico.

- /acordos/{id}/concluir - POST: método para concluir um acordo.

- /acordos/{id}/integrar - POST: método para integrar um acordo.

- /acordos/{id}/{nome} - GET: método para consultar os boletos em formato .pdf gerados pelo sistema.

- /acordos/parcelas - GET: método para consultar as parcelas do acordo.

- /acordos/abatimentos - GET: método para consultar os abatimentos dos acordos.

- /acordos/abatimentos/{id} - GET/PUT: métodos para consultar e integrar um abatimento de acordo específico.

- /acordos/pagamentos - GET/POST: métodos para consultar e incluir pagamentos de acordo.

- /acordos/pagamentos/{id} - GET/DELETE: métodos para consultar e estornar um pagamento de acordo específico.

- /acordos/origens - GET: método para consultar as dívidas originais vinculadas ao acordo.

- /acordos/{id}/marcadores - GET: método para consultar os marcadores do acordo.

- /acordos/{id}/marcadores/{idMarcador} - POST/DELETE: métodos para incluir e retirar o marcador de um acordo específico.

Agrupadores

- /agrupadores - GET: método para consultar agrupadores.

Aplicações

- /aplicacoes - GET: método para consultar aplicações financeiras do cliente.

- /aplicacoes/produtos - GET/POST/PUT/DELETE: métodos para consultar, incluir, alterar e cancelar os produtos das aplicações financeiras do cliente.

Assessorias

- /assessorias - GET: método para consultar as assessorias cadastradas.

- /assessorias/{id} - GET: método para consultar uma assessoria específica.

Atividades

- /atividades - GET: método para consultar as atividades geradas no sistema.

Autorizações

- /autorizacoes - GET: método para consultar as autorizações de cartão de crédito.

Boletos

- /boletos/registrar - POST: método para registrar diversos boletos.

- /boletos/{idParcela}/registrar - POST: método para registrar um determinado boleto.

Gateway de Pagamento

- /gatewaysPagamento - GET: método para consultar os gateways de pagamento cadastrados no sistema.

Batch

- /batch/{id} - GET: método para consultar um processo batch específico já iniciado.

- /batch/processar - POST: método para realizar o processamento diário do sistema.

- /batch/agrupadores - POST: método para realizar a importação de agrupadores.

- /batch/bloqueios - POST: método para realizar a importação de bloqueios de cliente.

- /batch/clientes - POST: método para realizar a importação de clientes.

- /batch/contratos - POST: método para realizar a importação de contratos.

- /batch/desbloqueios - POST: método para realizar a importação de desbloqueios de cliente.

- /batch/grupos - POST: método para realizar a importação de grupos.

- /batch/produtos - POST: método para realizar a importação de produtos.

- /batch/saldos - POST: método para realizar a importação de produtos.

- /batch/aplicacoes - POST: método para realizar a importação de aplicações.

- /batch/tarefas - POST: método para realizar a importação de tarefas.

- /batch/usuarios - POST: método para realizar a importação de usuários.

- /batch/socios - POST: método para realizar a importação de sócios.

- /batch/indicadoresMonetarios- POST: método para realizar a importação de indicadores monetários.

 - /batch/importacao - GET: método para consultar os processos batch.

 - /batch/notas-fiscais - POST: método para realizar a importação de notas fiscais.

Cliente

- /clientes - GET: método para consultar clientes.

- /clientes/{id} - GET/DELETE: método para consultar e deletar um cliente específico.

- /clientes/{id}/marcadores - GET: método para consultar os marcadores de um determinado cliente.

- /clientes/{id}/marcadores/{idMarcador} - POST/DELETE: método para incluir e retirar marcadores de um cliente específico.

- /clientes/{id}/cartoes - GET/POST/DELETE: método para consultar, incluir e deletar os cartões de crédito de um determinado cliente.

- /clientes/{id}/emails - GET/POST/DELETE: método para consultar, incluir e deletar os e-mails de um determinado cliente.

- /clientes/{id}/enderecos - GET/POST/DELETE: método para consultar, incluir e deletar os endereços de um determinado cliente.

- /clientes/{id}/telefones - GET/POST/DELETE: método para consultar, incluir e deletar os telefones de um determinado cliente.

Cobrador

- /cobradores - GET: método para consultar os cobradores cadastrados no sistema.

- /cobradores/{id} - GET: método para consultar um cobrador específico cadastrado no sistema.

Contrato

- /contratos - GET: método para consultar contratos.

- /contratos/{id} - GET/DELETE: método para consultar e deletar um contrato específico.

- /contratos/{id}/{parcelaId}.pdf - GET: método para consultar o boleto em formato .pdf de uma determinada parcela de um contrato.

- /contratos/{id}/marcadores - GET: método para consultar os marcadores de um determinado contrato.

- /contratos/{id}/marcadores/{idMarcador} - POST/DELETE: método para incluir e retirar marcadores de um contrato específico.

Interfaces

- /interfaces - GET: método para consultar as interfaces cadastradas no sistema.

- /interfaces/processar - POST: método para realizar o processamento da interface.

Marcadores

- /marcadores - GET: método para consultar os marcadores cadastrados no sistema.

Modelos

- /modelos - GET: método para consultar os modelos cadastrados no sistema.

- /modelos/{id} - GET: método para consultar um modelo específico cadastrado no sistema.

Global

- /global - GET: método para consultar informações globais do sistema.

- /global/processamento - GET: método para consultar informações do processamento diário do sistema.

Lote Serasa

- /loteSerasa - GET/POST: método para consultar lotes de Serasa e importar a remessa informacional do Serasa.

- /loteSerasa/{id} - GET/DELETE: método para consultar ou cancelar um lote específico do Serasa.

- /loteSerasa/{id}/enviar - POST: método para confirmar o envio de um lote específico do Serasa.

- /loteSerasa/{id}/importar - POST: método para importar o retorno de um lote específico do Serasa.

- /loteSerasa/{id}/exportar - GET: método para exportar o arquivo de remessa de um lote específico do Serasa.

Lote SPC

- /loteSpc - GET/POST: método para consultar lotes de SPC e importar a remessa informacional do SPC.

- /loteSpc/{id} - GET/DELETE: método para consultar ou cancelar um lote específico do SPC.

- /loteSpc/{id}/enviar - POST: método para confirmar o envio de um lote específico do SPC.

- /loteSpc/{id}/importar - POST: método para importar o retorno de um lote específico do SPC.

- /loteSpc/{id}/exportar - GET: método para exportar o arquivo de remessa de um lote específico do SPC.

Lote CNAB

- /loteCnab - GET: método para consultar lotes de CNAB.

- /loteCnab/{id} - GET/DELETE: método para consultar ou cancelar um lote específico de CNAB.

- /loteCnab/{id}/enviar - POST: método para confirmar o envio de um lote específico de CNAB.

- /loteCnab/{id}/importar - POST: método para importar o retorno de CNAB.

- /loteCnab/{id}/exportar - GET: método para exportar o arquivo de remessa de um lote específico de CNAB.

Negociações

- /negociacoes - GET: método para consultar as negociações cadastradas no sistema.

Perfis

- /perfis - GET: método para consultar os perfis cadastrados no sistema.

Propostas

- /propostas - GET: método para consultar as propostas.

- /propostas/efetivar - POST: método para efetivar uma proposta.

- /propostas/{id} - GET/DELETE: método para consultar ou cancelar uma proposta específica.

- /propostas/{id}/ativar - POST: método para ativar uma condição de uma proposta específica.

Restrição

- /restricoes - GET: método para consultar as restrições.

- /restricoes/{id} - GET: método para consultar uma restrição específica.

- /restricoes/excluir - POST: método para realizar a exclusão de restrições.

Tarefas

- /tarefas - GET: método para consultar as tarefas.

- /tarefas/efetivar - POST: método para efetivar tarefas agendadas.

- /tarefas/manual - POST: método para efetivar tarefas sem agendamento prévio.

- /tarefas/agendar - POST: método para agendar tarefas.

- /tarefas/cancelar - POST: método para cancelar tarefas.

Usuários

- /usuários - GET: método para consultar os usuários cadastrados no sistema.

Após preencher os campos e clicar em Salvar, o usuário é direcionado novamente a tela de filtro com a mensagem de sucesso. Nesta mensagem de sucesso, também é apresentado o Token do aplicativo. O token também é utilizado na autenticação do aplicativo, juntamente com o código. Por questões de segurança, ele é apresentado somente neste momento.

Se o usuário clicar em Cancelar, ele será direcionado a tela de filtro sem realizar a inclusão do novo aplicativo.

Na tela de filtro da administração de aplicativos, existe a possibilidade de editar e replicar os aplicativos já cadastrados. Ao clicar no botão Editar Aplicativo (ao lado de cada registro na tela de filtro), o usuário será direcionado a tela de detalhe na qual será possível alterar todos os campos apresentados, inclusive um outro campo disponível, conforme descrito abaixo.


Após preencher os campos e clicar em Salvar, o usuário é direcionado novamente a tela de filtro com a mensagem de sucesso. Nesta mensagem de sucesso, também é apresentado o Token do aplicativo. O token também é utilizado na autenticação do aplicativo, juntamente com o código. Por questões de segurança, ele é apresentado somente neste momento.

Se o usuário clicar em Cancelar, ele será direcionado a tela de filtro sem realizar a inclusão do novo aplicativo.

Na tela de filtro da administração de aplicativos, existe a possibilidade de editar e replicar os aplicativos já cadastrados. Ao clicar no botão Editar Aplicativo (ao lado de cada registro na tela de filtro), o usuário será direcionado a tela de detalhe na qual será possível alterar todos os campos apresentados, inclusive um outro campo disponível, conforme descrito abaixo.

- Token - Trocar: campo para alteração de token para o aplicativo. Ao clicar sobre o check “Trocar”, após salvar o cadastro do aplicativo, será gerado um novo token.

Ao clicar no botão Replicar Aplicativo (ao lado de cada registro na tela de filtro), o usuário será direcionado a tela de detalhe já contendo o vínculo com os agrupadores e as permissões selecionadas, cabendo ao usuário somente preencher os demais campos.