Jump to Content

Home Documentação Referências das Apis Changelog

Referências das Apis

Home Documentação Referências das Apis Changelog

All

Pages

Start typing to search…

Atendimento API

Atendimento
Atendimento
Tarefas
Tarefas

Assistência Técnica API

Assistência
Assistência
Visitas
- Realiza o cadastro de uma nova visita em uma assistência técnicapost
Visitas
Equipes
- Retorna as equipes de assistências técnicasget
- Retorna os usuários de uma equipe de assistências técnicasget
Equipes
- Retorna as equipes de assistências técnicasget
- Retorna os usuários de uma equipe de assistências técnicasget
Itens
- Realiza o cadastro de um item na assistência técnicapost
Itens
Localidade
- Retorna as localidades das assistências técnicasget
Localidade
- Retorna as localidades das assistências técnicasget
Área Comum
- Retorna as áreas comuns das assistências técnicasget
Área Comum
- Retorna as áreas comuns das assistências técnicasget
Itens de Manutenção
Itens de Manutenção
- Retorna os itens de manutenção das assistências técnicasget
- Retorna os itens de manutenção das assistências técnicaspost
Mensagens
- Realiza o cadastro de uma mensagem na assistência técnicapost
Mensagens
- Realiza o cadastro de uma mensagem na assistência técnicapost
Upload de arquivos na assistência técnica
- Faz o upload dos arquivos na assistênciapost
Upload
- Faz o upload dos arquivos na assistênciapost
Patologias
Patologias
Itens de Manutenção
- Retorna os itens de manutenção das assistências técnicasget
- Cadastra item de manutençãopost

Cadastro gerais do ambiente do CV

Tipos de Associações
- Retorna os tipos de associações disponíveisget
Tipos de Arquivos
- Retorna os tipos de arquivos disponíveisget
Correspondentes
Kit Decoração
- Esta API é responsável por retornar os kits decoração cadastrados no CVget

API de Clientes

Cliente
Cliente

API de Comissões

Comissão
Pagamentos da comissão

APIS - Comunicações

Assuntos
Atendimentos
Contratos
- Solicitação de envio por e-mail dos contratos associados ao clientepost
Empreendimentos
- Retorna os dados dos empreendimentos ativos no sistemaget
- Retorna as unidades disponíveis do empreendimentoget
Financeiro
Leads
- Realiza o cadastro de um novo leadpost
Pessoa
- Retorna os dados da pessoaget
Unidades
- Retorna os dados da unidadeget
Agendamentos
Leads

API de Corretores

Corretor

CVDW

Comissões
Distratos
- Retorna os distratosget
Reservas
Simulações
- Retorna os dados das simulaçõesget
Vendas
- Retorna os dados das vendasget
Unidades
Agendamentos
- Retorna os dados das vistoriasget
Assistências
Atendimentos
Leads
Filas de Distribuição
- Retorna a distribuição dos leadsget
Usuários Administrativos
- Retorna os dados dos usuários administrativosget
Processos
- Retorna os dados dos processosget
Pre-cadastro
Imobiliarias
- Retorna os dados das imobiliariasget
Corretores
- Retorna os dados dos corretoresget
Pesquisas
Repasses
Campanhas de Ativação
- Retorna as campanhas de ativaçãoget
Campos Adicionais
- Retorna os campos adicionaisget
Pessoas
Correspondentes
- Retorna os usuários correspondentesget
- Retorna as empresas correspondentesget

Empresas

Empresas
- /empresasget

API de Empreendimentos

Empreendimento
Etapa
- Cadastra etapa.post
Bloco
- Cadastra bloco.post
Unidade
- Cadastra unidade.post
- Retorna unidade.get
bloquear_unidade
- Bloqueia ou disponibiliza unidade.post
Motivos de Bloqueio Unidade
- Retorna motivos de bloqueio de unidade.get
campos_obrigatorios
- Retorna campos obrigatórios.get
Dados ERP
- Retorna dados ERP Sienge do empreendimento.get
referencia_externa
- Atualiza referência externa.put
Tipologias das Unidades
Empreendimentos Corretores
- Associar corretor a um empreendimentopost
Empreendimentos Imobiliárias
- Associar imobiliária a um empreendimentopost

API do Financeiro

Boleto
Extrato
- Salva os boletos para serem exibidos no portal do clientepost
IR
- salva a renda para ser exibida no portal do clientepost

Gestões de Distrato

Gestões de Distrato
- Retorna todas as gestões de distrato cadastradasget

Api de Gestões de Cessão

Gestões de Cessão
- get gestão de cessãoget

Gestões de Contrato

Gestões de Contrato
- Retorna todas as gestões de contrato cadastradasget

API de Imobiliárias

Imobiliária
Usuários Imobiliárias

Indexadores

Indexadores
- /indexadorget

Api de Indicadores

Leads

Integrações

Webhook

API de Leads

Leads
- Retorna leadsget
- Cadastra Leadspost
Atendentes das Filas de Distribuição de Leads por Tag
- Retorna os Atendentes das Filas de Distribuição de Leadsget
Consultar Atendimento do Lead
- Retorna os atendimentos dos Leadsget
Filas de Distribuição de Leads
- Retorna as Filas de Distribuição de Leadsget
Motivos de Cancelamento de Lead
- Retorna os Motivos de Cancelamento do Leadget
Conversões dos Leads
- Retorna as Conversões do Leadget
Tarefas
Interações
- Retorna as interações dos leadsget
Interações
- Retorna as interações dos leadsget
- Atualiza as interações dos leadsput
Leads
- Retorna leadsget
- Cadastra Leadspost
Atendentes das Filas de Distribuição de Leads por Tag
- Retorna os Atendentes das Filas de Distribuição de Leadsget
Consultar Atendimento do Lead
- Retorna os atendimentos dos Leadsget
Filas de Distribuição de Leads
- Retorna as Filas de Distribuição de Leadsget
Motivos de Cancelamento de Lead
- Retorna os Motivos de Cancelamento do Leadget
Conversões dos Leads
- Retorna as Conversões do Leadget
Indicadores Leads
Leads
- Retorna o listagem de leads por indicadoresget

Mapa Disponibilidade

Mapa Disponibilidade
- /mapadisponibilidade/{idEmpreendimento}get

Portal do Cliente API

Autenticação
Agendamentos
Assistências Técnicas
Associações de Pessoas
Atendimentos
Banners
- Retorna os banners ativos do painel do clienteget
Campos Adicionais
- Retorna os campos adicionais do clienteget
Comunicados
- Retorna os comunicados dos empreendimentos referente ao cliente logadoget
Configurações
Contratos
- Retornar os contratos das unidades do clienteget
Documentos
- Retorna os documentos do síndico get
Empreendimentos
Endereço
Financeiro
Financeiro CV
Itens de Manutenção
- Retorna os itens de manutenção das assistências técnicasget
Localidade
- Retorna as localidades das assistências técnicasget
Notificações
Portal de Benefícios
- Retorna os marketplaces vinculados a um portal do clienteget
Perguntas frequentes
- Retorna as perguntas frequentes do portalget
Permissões dos Perfis
- Retorna as permissões dos perfis do cliente de acordo com configuração do painel do clienteget
Permissões dos Síndicos
- Retorna as permissões do síndico de acordo com configuração do painel do clienteget
Pesquisas
- Retornar as pesquisas ativas para o usuárioget
- Retorna as resposta do cliente de uma pesquisaget
Pessoa
Pré Cadastros
- Retorna os pré cadastros do cliente pendentes de documentoget
Reservas
- Retorna as reservas do cliente pendentes de documentoget
Resetar Senha
Síndico
Termo de Aceite
- Retorna um termo a ser aceitado pelo clienteget
- Realiza o aceite do termopost
Unidades
Assistências Técnicas
- Cadastra uma mensagem na assistênciapost
- Cadastra uma visita técnicapost
Atendimentos
- Responde um determinado atendimentopost
- Avalia um atendimentopost

API de Pré-cadastro

Pré-cadastro
Documentos
Pré-cadastro
- Retorna a lista de pré-cadastros com filtro de indicadorget

Profissões

Profissões
- /profissoesget
- Cadastrar uma profissão no CVpost

Notificações

Repasse
- Retorna repassesget
- Altera situação de um repassepost

API de Reservas

Reserva
Alterar Situação
- Altera situação da reservapost
Informar Venda
- Atualiza situação da reserva para vendidapost
Distrato
Cessão
- Retorna as cessões de direitosget
- Realiza cessão de direitos de uma reservapost
Cancelamento
- Altera situação da reserva para canceladapost
Contratos
Parcelas da reserva
- Retorna todas as parcelas de pagamento da reservaget
- Cadatra boletos das parcelas quando for tipo ato ou sinalput
Boletos
- Cadastra boleto para parcela de série do tipo Ato ou Sinalpost
- Atualiza boleto para parcela de série do tipo Ato ou Sinalput
Lotes
Documentos
- Retorna os documentos cadastrados na reservaget
- Cadastra documentos na reservapost
Condição de Pagamentos da Reserva
- Retorna as condições de pagamento de uma reservaget
Dados ERP
- Retorna dados do ERP Sienge da reservaget
- Atualiza dados do ERP Sienge em uma reservaput
Campanhas
- Retorna as campanhas cadastradas na reservaget
Mensagens
- Retorna a(s) mensagem(s) de uma reservaget
- Cadastra uma nova mensagempost
Análises de Crédito
- Retorna a(s) análise(s) de crédito de uma reservaget
Kit Decoração
- Retorna os kits de decoração da reservaget
- Associa um kit de decoração a uma reservapost
Correspondente
- Altera o correspondente da reservaput
Reserva
Alterar Situação
- Altera situação da reservapost
Informar Venda
- Atualiza situação da reserva para vendidapost
Distrato
- Retorna distratos de reservasget
- Altera situação da reserva para distratopost
Cessão
- Retorna as cessões de direitosget
- Realiza cessão de direitos de uma reservapost
Cancelamento
- Altera situação da reserva para canceladapost
Repasse
Contratos
Boletos
- Cadastra boleto para parcela de série do tipo Ato ou Sinalpost
- Atualiza boleto para parcela de série do tipo Ato ou Sinalput
Lotes
Documentos
- Retorna os documentos cadastrados na reservaget
- Cadastra documentos na reservapost
Condição de Pagamentos da Reserva
- Retorna as condições de pagamento de uma reservaget
Dados ERP
- Retorna dados do ERP Sienge da reservaget
- Atualiza dados do ERP Sienge em uma reservaput
Campanhas
- Retorna as campanhas cadastradas na reservaget
Mensagens
- Cadastra uma nova mensagempost
- Retorna a(s) mensagem(s) de uma reservaget
Análises de Crédito
- Retorna a(s) análise(s) de crédito de uma reservaget
Kit Decoração
- Retorna os kits de decoração da reservaget
- Associa um kit de decoração a uma reservapost

API de Séries de Tabelas de Preços

Tabelas de Preços
- Recupera a lista de tabelas de preçoget
Séries de Tabelas de Preços
- Cadastro de Séries de Tabelas de Preçospost
- Recupera a lista de tabelas de preço completaget
Tabelas de Preços
- Retorna as tabelas de preço ou uma tabela de preço mais detalhadaget
- Retorna as tabelas de preço ou uma tabela de preço mais detalhadaget

Usuários Administrativos

Usuários Administrativos
- /v1/configuracoes/usuariosadmget
- /v1/configuracoes/usuariosadm/perfilget
Autenticação
- Envia o código de verificação para autenticação externapost
- Gera o token de autenticação externapost
Esqueci Senha
Senha Expirada
- Alterar senha expiradapost

Workflow API

Workflow
- /workflows/{funcionalidade}get
- /workflows/{funcionalidade}/{idSituacao}get
Workflow
- /workflows/{funcionalidade}/subworkflowsget

Geral API

Autenticação
- Gera um token de acesso para o usuáriopost
Último Acesso
- Retorna o ultimo horário que o usuário acessou o sistemaget

APIS - Comunicador

Atendimentos
Empreendimentos
Leads
Encerrar Chat
Excluir Chat
Marcar mensagens como lidas

Localidades API

Localidades

Gestões de Time

Gestões de Time
- Retorna uma gestão de time cadastradaget

Retorna as cidades

get

https://{dominiodocliente}.cvcrm.com.br/api/v1/localidades/estados/{idestado}/cidades

Language

URL

Click Try It! to start a request and see the response here!