Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

O PVI ou Portal de Vendas de Imóveis é Imóveis é um software desenvolvido com o propósito de auxiliar as equipes de vendas das construtoras e imobiliárias no processo de gestão de vendas. 
Ao desenvolver o PVIPortal de Imóveis, a principal finalidade foi dar visibilidade, transparência e controle durante todo o ciclo da venda, sempre integrando as informações do RM.

Exibir filhos

...

idPVI - Manual do Usuário

...

labelPVI em Geral

...

idPVI - Manuel do Usuário

...

labelBackend |

Sobre parâmetros do Backend

No Backend são feitos os cadastros de Usuários , Empreendimentos - Comunicação com RM.

...

idBackend

...

labelEmpreendimento |

Cadastro de Empreendimento no PVI é importado pelo TCGI no processo de Sincronização.

Image Removed,

A ativação dos empreendimentos realizada no PVI consiste no número de licenças disponíveis, incluindo os empreendimentos "Ocultos",

neste exemplo , o limite é de 5 Empreendimentos Ativos.

Image Removed

Esses 3 cadastros acima pertencem aos Cadastros Globais

Image Removed T

TMA : Taxa de Desconto - Cadastro Global 

Uma taxa de desconto , Exemplo da Utilização do TMA : A unidade custa R$100.000,00 , para entregar em 2025 ( Estamos em 2021 )  consegue trazer este valor para o presente com uma taxa de desconto  seja por fórmula de matemática financeira, e é mostrado ao usuário um exemplo que se pode vender determinada unidade até X com desconto que vai mostrar se pode ou não ser viável.

Image Removed

...

.

...

Para aprender e entender mais acerca do Portal de Imóveis, comece pelo link abaixo que irá guiá-lo por todos os processos e rotinas da ferramenta.

Image Removed

Pode ser visualizado Logs de : Propostas - Reservas e Unidades 

Image Removed

Exemplo de Log de Proposta 

Informações

Percentual de Comissão : Conforme explicado sobre % de Comissão ( Busca % por ordem de prioridade de Comissão ).

Comissão Adicional :

Image Removed

Comissão : Para por AMBOS .

Image Removed

Para que possa ser utilizada este funcionalidade deve estar marcado  o Parâmetro acima como : AMBOS

Image Removed

Após marcar como AMBOS a comissão paga pelo Cliente e Empresa , deixar como SIM o parametro de Comissão paga pelo Cliente e Empresa - Gerente recebe sempre pela Empresa

Cadastro de % das comissões no TCGI e PVI.

Cliente passa a ter o poder de escolher a opção de pagar parte da comissão pela empresa e parte pelo cliente. 

Image Removed

Image Removed

Quando se marca Ambos :  Cliente pode informar no cadastro do Empreendimento a Porcentagem paga pela Empresa e pelo cliente que é informado no PVI.

Mas esse campo fica bloqueado pelo usuário , não podendo alterar pelo PVI , a não ser que o grupo de usuário esteja parametrizado.

Image Removed

Habilitar o campo no Grupo de usuário para ( ALTERAR PERCENTUAL DA DISTRIBUIÇÃO DA COMISSÃO PAGA PELO CLIENTE E EMPRESA ).

Image Removed

Campo passa a ficar habilitado para edição via PVI também.

Informações
titleDefaul na Simulação de Proposta.

Sistema irá verificar os parâmetros de Comissão primeiramente no cadastro de Empreendimento e se o mesmo não estiver marcado , irá verificar a parametrização em Parâmetros | Propostas.

Image Removed

Neste exemplo , irá pegar o Defaul nos parametros | Proposta e ao simular uma proposta , irá estar marcado para AMBOS.

Esses parametros são utilizados na hora da Proposta , se comissão será pago pelo cliente ou Empresa por exemplo.

Visão da vaga de garagem: Se quer mostrar ou não.

URL para video de Youtube : Para informação do Empreendimento , mostra imagem , planta e videos. ( Fica em Informação do Empreendimento ).

Ordem de disposição do mapa de disponibilidade: Imagem , planta do loteamento ( Ordem que deseja ser visto primeiro, Tabela de preço ou Mapa de Disponibilidade ).

Gerente :  Definido um gerente e seu %, quando tiver uma venda , o gerente vai ganhar também este valor de comissão da venda que tiver definido no parâmetro.

Image Removed

Este parametro marcado , cliente tem um SInal em Janeiro de 2021 e a primeira parcela Mensal será em Julho de 2021, com este parametro marcado , cliente será notificado todo mês até chegar Julho , mas só informativo , pois ele será informado mensalmente.

Image Removed

Unidades: Unidaes do Empreendimento

Imagens : Imagens que podem ser colocadas para serem visualizadas no PVI.

Image Removed

Minutas: É um contrato impresso ,PVI existe um exemplo de documento para baixar como mostra a figura acima.

Image Removed

Pode se adicionar Tags, editar a Minuta, que as Tags serão substituídas por valores e assim a minuta será apresentada. 

Editar > Comissão

Dentro do menu comissão, estará disponível a opção  "permite descontar comissão do corretor" , onde será possível definir se a comissão será ou não descontada da comissão do corretor. por exemplo, 

suponhamos que a comissão do corretor foi definida 10%, o percentual de comissão do gerente definido como 1%, então será descontado na porcentagem do corretor 1%, em cima dos 10% que ele iria receber, sendo assim o corretor passará a receber 9%.

Image Removed

Para realizar basta o preencher os dados, informar o nome do gerente que irá receber a comissão marcar o checkin-box "permite descontar comissão do corretor" e clicar em salvar, feito isso, após concluir o cadastro de uma proposta, acesse a opção Image Removed vá até comissão, e será demostrado os valores das comissões informados  para o empreendimento desejado.

Informações
titleImportante:

A respeito das Tags: proposta.valor_contrato e proposta valor_contrato_real, é importante destacar que há diferença nos valores que compõe as mesmas, quando na proposta houver PRICE/FORMULA seja com ou sem correção monetária.

Em uma modalidade com componentes cujo modelo de cálculo seja o padrão, as Tags receberão o mesmo valor, mas se houver componentes com PRICE/FORMULA seja com ou sem correção a Tag proposta.valor_contrato receberá o valor com a soma das parcelas PRICE/FORMULA calculadas.

Já para a TAG proposta valor_contrato_real o valor será exibido sempre sem correção, ou seja, o valor original da venda.
 
Exemplo:
 
Proposta sem PRICE/FORMULA com valor total = 100.000
Proposta com PRICE/FORMULA a 1% em 10 x = 105.582,08
 
Se no PVI o parâmetro usar valor das parcelas PRICE for "NÃO" então ambas as Tags serão iguais!

Image Removed

Documentos da Proposta : Cadastro em Globais | Documento da Proposta

Image Removed

Image Removed

Pode-se criar documento de proposta e este mesmo estando criado , vai mostrar no cadastro do Empreendimento , marcado o documento , será visualizado na Proposta com a regra criada no Documento.

Card
labelLogs |
Card
labelImagem em Empreendimento |

Inserindo Imagem no cadastro de Empreendimento - Backend e visualizando no Frontend ao simular proposta.

Image Removed

Backend | Empreendimentos

Image Removed

Selecionar o Empreendimento - Em seguida ( Editar ).

Image Removed

Clicar em : Imagens Disponibilidade.

Obs: Lembrar que a resolução recomendada é de 1.250 Pixeis - Horizontal.

Clicar em : Adicionar Imagem e em seguida : Nova Imagem.

Image Removed

Salvar Imagem no Empreendimento.

Image Removed

Pode ser feito o posicionamento das Unidades na Imagem.

Image Removed

Basta selecionar a Unidade e arrastar até o local desejado.

Image Removed

Ao entrar em Frontend e em seguida em Empreendimentos , a imagem fica visível e com as unidades posicionadas.

Card
labelFrontend

Processos PVI - Frontend

Deck of Cards
idProcessos do PVI.
Card
labelPré-Venda |

O menu Pré-Venda possui informações importantes que podem ser utilizadas antes de realizar a proposta.

Deck of Cards
idPré-Venda
Card
labelAlçadas de Aprovação |

É possível definir alçadas de aprovação respeitando o grupo de usuários, para cada grupo é definido um % VLP.

Informações
titleImportante:
  • É necessário realizar um aprovação dupla(usuários diferentes) para que a Alçada de Aprovação fique Ativa. A permissão para realizar o processo é concedida no cadastro de Grupo de usuários.
  • O percentual de VPL padrão para todos os empreendimentos e grupos é de 100%, portanto para que um grupo possa conceder 2% de desconto, o percentual da taxa de aprovação que este deve possuir é 98%.
  • Ordem utilizada para buscar a porcentagem de desconto aceito em uma unidade do empreendimento em proposta.
    0 - Sistema inicia o percentual VPL esperando que seja 100%(Caso não exista Alçada de Aprovação para o Empreendimento/unidade)
    1 - Unidade promoção por grupo usuário (Alçada de aprovação)
    2 - Modalidade Taxa VPL (caso haja modalidade principal do empreendimento e a taxa VPL for maior que 0)
    3 - Empreendimento percentual VPL aprovação.
  • Caso já exista alguma alçada cadastrada, é importante realizar uma conferencia dos % para os grupos de usuário.

Para realizar o cadastro de uma alçada é necessário estar no Frontend e em seguida acessar o menu Pré-Venda>>Alçadas de Aprovação.

Image Removed

Nesta visão será possível consultar, editar, incluir ou excluir uma alçada de aprovação. Para realizar a inclusão de uma nova alçada será apresentado no menu superior direto um botão Adicionar:

Image Removed

Na inserção de uma nova alçada alguns campos serão de preenchimento obrigatório:

Inicio: Data de inicio de validade dessa alçada.
Fim: Data de fim de validade dessa alçada.
VPL de Aprovação: será listado todos os grupos cadastrados permitindo informar um % para cada grupo.
Empreendimento: Deve ser selecionar um Empreendimento para a alçada, após selecionar o empreendimento será listados todas as subunidade do empreendimento permitindo a sua seleção.

Image Removed

Após o cadastro será necessário aprovar a Alçada, este procedimento deve ser realizados por usuário com permissão para essa ação(Grupo de usuário).

Image Removed

Após realizar a aprovação dupla(usuário diferentes) a alçada está ativa e será utilizada em novas propostas. Caso seja preciso realizar algum ajuste na Alçada será necessário nova aprovação para que a mesma fique ativa.

Exemplo de utilização

No cadastro da Alçada de Aprovação informei que para os usuários vinculados ao grupo Administrador o percentual de VPL é 98%.

Image Removed

Com essa configuração usuários vinculados ao grupo Administrador ao realizar uma proposta para uma subunidade que possui essa alçada de aprovação poderão conceder um desconto de até 2%, visto que o valor mínimo de VPL é 98% para este grupo de usuário. Caso o usuário tente informar um desconto maior que 2% ao tentar validar as condições de pagamento da proposta será apresentado uma mensagem informando que a proposta não foi aprovada. 
Image Removed
Image Removed
Image Removed Card
labelBrinde na compra |

No brinde na compra poderá se associar a uma proposta, que ao ser finalizada o comprador recebera, esse brinde poderá ser exibido no contrato da proposta. 

Para adicionar algum brinde na compra a uma determinada proposta basta acessar o menu Pré-Venda>>Brinde de compra, ou então

basta que as proposta tenham brindes cadastrados, que na simulação da proposta serão listados os brindes cadastrados.

Image Removed

Nesta opção você deverá associar o brinde da proposta ao empreendimento desejado, basta clicar no botão Adicionar.

Image Removed

Então será exibido a tela de cadastro do brinde, no campo empreendimento deverá ser informado o empreendimento no qual o brinde será associado

Image Removed

Logo após salvar o brinde ao empreendimento associado, em simular a proposta, na parte inferior da tela será exibido o o brinde que foi adicionado

aquele imóvel.

Image Removed

Marcando o checkbox Participa, você estará habilitando essa opção para ser visível no documento de impressão.

Card
labelSimular reserva - Tabela de Preço RM / PVI |

Cadastro de Empreendimento no RM - visualizado no PVI

Image Removed

Cadastado Empreendimento dentro do RM e após Sincronizmo , visualizado no PVI como mostra a imagem acima em : Empreendimentos

Image Removed

Mapa de Disponibilidade 

Image Removed,

Cadastro de Blocos no PVi - Mostra os Blocos cadastrados no RM com sua quantidade

Image Removed

Para efetuar a reserva ou simular, basta selecinar a Unidade e marcar a opção desejada. ( Neste Exemplo : Simular ).

Ao selecionar uma Unidade, o PVI mostra as Tabelas de Preços vinculada ao Empreendimento.

Cadastro das tabelas de preços no RM e o vínculo ao Empreendimento , como são feitos :

Image Removed

No RM , o cadastro de tabela de Preço vinculada ao Empreendimnto PVI , Mostra 3 Ativas e 2 Canceladas, As cancelas não são visualizadas no PVI , sendo informado no PVI as efetivadas.

Image Removed

Descrição da Tabela de Preço que é visualizada no PVI e dentro da Tabela de Preço , vinculada a Modalidade que será utilizada para o Plano de Financiamento.

Image Removed

Ao Seguir o Processo de Simular ( Print Acima )  - Mostra na tela do PVI os Componentes que estão cadastrados dentro da Tabela de Preço do RM .

Image Removed

Uma unidade só pode ter uma proposta , campo Imobiliária será preenchido automaticamente ao inserir o Corretor que está vinculao a ela , mas esse campo Imobiliária não é necessário preenchimento.

Corretor não é associado a nenhuma imobiliária e faz uma venda , e esta venda foi especifica para uma Imobiliária , ai neste camo de Imobiliária é informada a mesma e a comissão é paga para Imobiliária que fica responsável por repassar ao Corretor sua comissão. 

No cadastro da Pessoa, pode buscar um já existente informando o CPF ou pode cadastrar um novo nesta tela de proposta.

Image Removed

Relembrando sobre Comissão que já foi faldo no Help de Backend.

Ai define quem vai pagar a comissão , se será o cliente ou empresa , isso será fundamental na hora de enviar para o TCGI o valor da Proposta e essa % de Comissão é realizada pelas 4 Etapas na configuração de Comissão. ( Relembrar ) 

Image Removed

Primeiro buscar em Empreendimento = Neste exemplo 0% e ai irá buscar no cadastro de usuário a % de comissão que será pago .

Image Removed

Segunda busca no Cadstro de Usuarios - Como estou com Mestre , achou 8% e a busca para neste momento , PVI não faz a busca mais em Imobiliária e Grupo de usuários.

Informações
titleObservação sobre Restringe e Não Restringe Modalidade no PVI !!

Image Removed

 O PVI lê as modalidades do TCGI,  as modalidades podem ser RESTRINGE NO PVI ou NÃO RESTRINGE NO PVI. Comportamento de cada tipo:
- NÃO RESTRINGE - Modalidade pode receber qualquer componente mesmo que não esteja cadastrado na modalidade originalmente.
Ex: modalidade no RM
- Sinal
- Mensal
- Financiamento

NO PVI foi definido uma proposta com os componentes Sinal, Mensal, Anual, semestral e financiamento. Desta forma a modalidade NÂO RESTRINGE aceita esta proposta com novos componentes que não estavam orignalmente na modalidade.

- RESTRINGE NO PVI - Neste caso o PVI apresentará a modalidade exatamente como ela está definida no RM e não permitirá acrescentar novos componentes, somente eliminar.

Processo de integração da venda seguem duas situações
MODELO DE MODALIDADE - se a modalidade for RESTRINGE NO PVI, a volta da venda será de acordo com a modalidade, ou seja, no mesmos grupos e somente os mesmos componentes da modalidade.

Se o modelo da modalidade for NÃO RESTRINGE NO PVI, ao enviar a venda para o RM o PVI irá consultar o parâmetro em backend > parametros > TOTVS, Separar componente em grupos, se este parâmetro for SIM, a venda será criada com cada componente da venda em um grupo distinto e em cada grupo serão copiados todos os componentes de reajuste.
Se o parâmetro acima for NÂO, ao enviar a venda o PVI colocará todos os componentes no mesmo grupo e somente abrirá um novo grupo caso na proposta existam mais de um componente do mesmo tipo.

Image Removed

Exemplo:

Proposta cuja modalidade = NÂO restringe e saparar componentes por grupo ( NÃO ).

  • Sinal
  • Mensal
  • Mensal
  • Anual
  • Financiamento

Ao enviar a venda o PVI agrupará os componentes.

Grupo 1

  • Sinal
  • Mensal
  • Anual
  • Financiamento

Grupo 2

  • Mensal

Image Removed

Após conferência , validar valores - Validar.

Image Removed

Por fim , Salvar Proposta.

Image Removed

Image Removed

Comissão - Para que serve esse campo na Proposta ao editar ?

Image Removed

Uma venda existe uma parceria com outro corretor que ficou combinado o pagamento de uma parte da comissão , A comissão fechada é em 8% pelo contrato , neste caso , pode incluir um novo corretor e informar a % de comissão para pagamento , mas o total delas não pode ultrapassar os 8% , se incluir 1% para o novo corretor , tem que tirar 1% dos 8 acima .. Ficando 7% e 1 % totalizando os 8%.

Em Propostas : A proposta criada , fica na tela do PVI ( Status = Aprovada )

Image Removed

Para imprimir a Proposta : Basta clicar no Botão da Imagem .

Image Removed

Image Removed

Enviar proposta por E-mail , tem Tags que podem ser incluidas no corpo do e-mail ao enviar a Proposta.

Documentos da Pessoa : Conforme parametrização do cadastro da Pessoa , se tiver algum documento obrigatório , vai ser informado e ai o usuário pode ou não aprovar o documento.

Image Removed

Tabela de Preço: Ao utiliza financiamento padrão e o componente gerador de parcela calcula por fórmula será apresentado um botão 'Calcular', possibilitando a atualização do valor da parcela de acordo com a fórmula utilizada. Caso seja utilizado outro modelo de financiamento o valor da parcela será apresentando considerando o Valor Unidade / Quantidade de parcelas.

Image Removed

Card
labelAvançar Etapa - Assinar Proposta |

Image Removed

Para avançar a Etapa da Proposta : Selecionar a Proposta e em Seguida o Botão da imagem acima.

Image Removed

Selecionar opção : Avançar Etapa da Proposta

Image Removed

Selecionar a etapa que a proposta será avançada e em Seguida ( Salvar ).

Image Removed

Proposta passando para Status : CONTRATO ASSINADO

Image Removed

E o status de Contrato Assinado no PVI - Permite enviar venda para o BackOffice e esta vinculado ao Contrato Assinado do TCGI conforme já informado nos cadastros do Backend.

Card
labelEnviar contrato para o RM |

Image Removed

Contrato assinado - Agora voltar a clicar no botão ao lado da Proposta e : Enviar Contrato para o Backoffice.

Informações
titleImportante:

Para envio da venda, faz-se necessário que no TGGI o parâmetro de venda sequencial esteja habilitado. Em instalações em que o parâmetro de venda sequencial não estiver habilitado fica sujeito a erro de chave duplicada ao enviar a venda.

Image Removed

É carregado os dados da Proposta.

Se o Comprador já tiver cadastro no RM , o CPF for localizado , será atualizado os dados no RM e será habilitado botão no PVI para atualizar dados cadastrais, caso não exista no RM , os dados no comprador novo serão enviados juntamente com o Contrato.

Image Removed

Clicar em Iniciar o processo de 7 etapas.

Image Removed.

Image Removed

Image Removed

Contrato enviado para o RM.

Sistema passa por 7 passos.

Image Removed

Contrato enviado para o RM.

Image Removed

PVI lhe dá opção de Excluir a Proposta depois que encontra-se Assinada.

Card
labelComissão paga pelo Cliente |

Image Removed

Uma nova Proposta feita com Cliente pagando a Comissão.

Image Removed

Imprimir Proposta para verficar o valor antes de enviar para TCGI.

Image Removed

Mostra a Comissão sendo paga pelo Cliente neste momento.

Enviar para o TCGI o contrato para verificar o valor.

Image Removed

Id da Venda = 978

Image Removed

Venda enviada para o RM.

Image Removed

Venda chegou no TCGI com valor de 92 Mil Reais.

Card
labelComissão paga pela Empresa ( Vendedor no Contrato de venda do TCGI ) |

Image Removed

Primeiro passo para se realizar uma proposta com comissão paga pela empresa e que possa sair vendedor no contrato de Venda / Aluguel no TCGI - Verificar cadastro de Cliente/Fornecedor no RM.

Observar o CPF do cadastro.

Em Dados Adicionais : Verificar usuario vinculado e e-mail do Usuário.

Image Removed

Dados importantes para cadastro de Usuario no PVI :

  • CPF 
  • E-mail

Verificar se usuario tem permissão no TCGI.

Image Removed

Feita as validações , verificar cadastro de usuário no PVI em : BACKEND | Usuários 

Cadastro deve possuir o mesmo CPF e mesmo E-mail do cadastro feito no RM.

Image Removed

Efetuar uma nova reserva

Image Removed

Na proposta o Corretor tem que estar preenchido com o Usuário PVI vinculado ao usuário RM.

Image Removed

Quem paga Comissão : Empresa 

Por fim , validar proposta e Salvar em seguida.

Enviando Contrato para o TCGI>>>>>

Image Removed

Contrato : 980 envaido para o TCGI.

Image Removed

Contrato enviado para TCGI.

Localizar contrato 980 em seguida : Anexos | Vendedores

Image Removed

Vendedor incluído no contrato de Venda/Aluguel

Image Removed

Valor total no contrato , diferente do contrato que comissão é paga pelo cliente que já vem descontando os 8%.

Image Removed

No cadastro do Vendedor , incluir o valor da parcela e quantidade de parcela ( pagar a comissão ).

Campos Complementares - Informar o valor da Comissão.

Selecionar Processos | Gerar Comissão( ões ).

Image Removed

Processo executado.

Image Removed

Movimento gerado para TOTVS Getão de Estoque, compras e Faturamento.

Card
labelComissão paga por AMBOS |

Comissão paga por Ambos ( Empresa e Cliente ) Dividem o valor de Comissão conforme parametrização.

Image Removed

Parâmetros do Empreendimento = Informo se a comissão será paga pela Empresa , Cliente ou Ambos , mas esse parametro pode ser informado nos parametros do PVI em Propostas e o Percentual da Comissão ou na própria Proposta.

Sobre o Valor da % de comissão que será pago pela Empresa e Cliente , é cadastrado no Empreendimento e pode ser editado na própria proposta do PVI se o cadastro do usuario no PVI ( Grupo de usuários estiver parametrizado para que possa editar ).

Image Removed

Proposta no PVI = Valor de 100.000 Reais 

E neste exemplo a comissão esta marcada como ( AMBOS ) e 50% para Cliente e Empresa .

Image Removed

Proposta criada.

Image Removed

Visão de Comissão no PVI.

Image Removed

PVI mostrando o valor que Cliente e Empresa irão pagar para Gerente e Corretor.

Image Removed

Proposta impressa ( valores ).

Image Removed

Contrato assinado - Enviar para TCGI.

Image Removed

Proposta enviada para o RM ( Venda = 986 ).

Image Removed

Contrato enviado para o TCGI

Image Removed

Vendedor - Corretor incluído no Contrato de Venda do TCGI para inserir a Comissão.

Card
labelEmpreendimento |

Image Removed

Tela de Empreendimento do Frontend ,pega toda configuração do Empreendimento no BacKend , Informações cadastradas, efetuar a simulão de proposta.

Card
labelCorretores |

Importante!
Ao realizar uma proposta, o corretor poderá selecionar a imobiliária atual no campo Imobiliária, mas por padrão será auto selecionado a imobiliária definida no cadastro do usuário.
Esta informação será gravada no momento em que a proposta é feita. Desta forma o PVI consolida um histórico de imobiliárias que o corretor pertence ou pertencia no momento em que a proposta foi realizada.

Relatórios gerenciais

É importante notar que o campo imobiliaria_proposta (imobiliária_id) da tabela proposta será o responsável pelo armazenamento das informações a respeito deste histórico de imobiliárias. Abaixo, segue um exemplo de select onde extraímos esta informação diretamente do banco.

Image Removed

Usamos o comando COALESCE para buscar primeiro em proposta se houver valor para imobiliária, se existir, este será o valor a ser considerado, caso não exista aí buscamos a imobiliária vinculada ao usuário. Vale lembrar que isso é para manter compatibilidade com as propostas antigas, a partir da nova versão, se houver imobiliária ela sempre estará disponível na proposta.

Card
label| API

Acessar Documentação da API

Com a instalação do PVI é disponibilizado a documentação técnica das APIS utilizadas e as respectivas rotas consumidas pelo portal. Para acessar a documentação no Swagger é necessário adicionar o caminho a seguir 'api/ui/#/' no endereço do Portal em seu navegador.

Por exemplo: Considerando uma instalação local do PVI utilizando a porta 8000 para visualizar a documentação é necessário digitar o seguinte endereço no navegador.

Image Removed

               Servidor:Porta/api/ui/#/

Essa documentação é sempre atualizada considerando as novas APIS e as alterações nas existentes. 

Configuração da API - CORS

Para o consumo da API do portal de vendas diretamente por browsers(navegadores) ou client http de aplicativos front end como fetch API, jQuery, Axios, Angular Http, etc, será necessário que a instalação do portal envie na requisição de resposta alguns cabeçalhos específicos que para não infringir a política de CORS. Caso queira entender mais sobre CORS clique aqui

Os cabeçalhos necessários são:

  • Access-Control-Allow-Origin
  • Access-Control-Allow-Headers
  • Access-Control-Allow-Methods

Dado que o portal usa o IIS para servir a API, será necessário customizar este arquivo ./api/Web.config com estes parâmetros:

<httpProtocol>
   <customHeaders>
      <add name="Access-Control-Allow-Origin" value="*" />
      <add name="Access-Control-Allow-Headers" value="X-Requested-With, Content-Type, Accept, Origin, Authorization" />
      <add name="Access-Control-Allow-Methods" value="GET, POST, PUT, DELETE, PATCH" />
      <add name="Access-Control-Max-Age" value="1000" />
   </customHeaders>
</httpProtocol>

Dando um visão geral, o arquivo /api/Web.config ficará semelhante a este:

Image Removed

Feito este procedimento, a API está preparada para ser consumida por aplicativos de fora do domínio do portal.Problemas de CORS em aplicativos Angular

Mesmo o servidor enviando os cabeçalhos que atendem os requisitos de CORS ainda a requisição está com problema? Se resposta for sim, pode ser configurado um cabeçalho na requisição com header Content-Type. Veja um exemplo de chamada com o cabeçalho:

Image Removed

Seria interessante manter o envio dos headers em um provider de http intercept, que para que toda chamada a API seja incluído o cabeçalho necessário, isso evita repetição de código e centralizada a configuração em um único ponto. O Angular possui este recurso e pode ser consultado por aqui.