A API do CVCRM utiliza um modelo de controle de acesso baseado em permissões, sejam por perfil de acesso do usuário administrativo a que o token pertence bem como a situação do workflow da funcionalidade.
Cada endpoint está vinculado a uma permissão específica dentro do módulo correspondente (Reservas, Leads, Atendimentos etc.). Esta permissão é a mesma usada na aplicação do CVCRM.
Para acessar um recurso, o usuário ou integração precisa ter a permissão correta.
Sem ela, a API retornará erro de autorização (403 – Forbidden).
• Método HTTP define a ação:
- GET → Consultar/Listar
- POST → Criar/Cadastrar/Atualizar
- PUT → Atualizar/Modificar
- DELETE → Excluir/Remover
Módulo de Negócio organiza os endpoints por área funcional:
- Reservas
- Distratos e Cessões
- Repasses
- Leads
- Pré-cadastro
- Comissões
- Tabelas de Preços
- Assistência Técnica
- Atendimentos
- Agendamentos
Documentação da API
Reservas
| Método |
Endpoint |
Permissão |
| GET |
/comercial/reservas |
Administrar reservas |
| GET |
/comercial/reservas/{idReserva} |
Administrar reservas |
| PUT |
/comercial/reservas |
Administrar reservas |
| POST |
/comercial/reservas |
Criar nova reserva |
| POST |
/comercial/reservas/alterar-situacao |
Alterar situação da reserva |
| POST |
/comercial/reservas/informar_venda |
Alterar situação da reserva |
| POST |
/comercial/reservas/cancelar-reserva |
Alterar situação da reserva |
| GET |
/comercial/reservas/{idReserva}/contratos |
Administrar reservas |
| GET |
/comercial/reservas/condicao-pagamentos |
Administrar reservas |
| POST |
/comercial/reservas/boletos |
Modificar Série com Boleto Ato |
| PUT |
/comercial/reservas/boletos |
Modificar Série com Boleto Ato |
| GET |
/comercial/reservas/{idReserva}/documentos |
Adicionar documento das reservas |
| POST |
/comercial/reservas/documentos |
Adicionar documento das reservas |
| GET |
/financeiro/lotes/{idLote} |
Listar lotes |
| POST |
/financeiro/lotes/cadastrar |
Modificar informações do lote |
| PUT |
/financeiro/lotes/{idLote}/alterar |
Modificar informações do lote |
| GET |
/cvio/tabelasdepreco |
Listar Tabelas de Preços |
| GET |
/v1/cv/tabelasdepreco |
Listar Tabelas de Preços |
| GET |
/v1/cv/seriestabelasdepreco |
Listar Séries |
Distratos e Cessões
| Método |
Endpoint |
Permissão |
| GET |
/comercial/gestoes-distrato |
Listar Gestão de Distratos |
| POST |
/comercial/reservas/distratos |
Cadastrar e Modificar Distrato |
| POST |
/comercial/reservas/distratos |
Cadastrar e Modificar Distrato |
| GET |
/comercial/gestoes-cessao |
Listar Gestão de Cessão |
| POST |
/comercial/reservas/cessao |
Efetuar cessão das reservas |
Repasses
| Método |
Endpoint |
Permissão |
| GET |
/financeiro/repasses |
Administrar |
| POST |
/financeiro/repasses /{idRepasse}/alterar-situacao/{idSituacao} |
Modificar situação do repasse |
Leads
| Método |
Endpoint |
Permissão |
| GET |
/lead |
Administrar lead |
| POST |
/lead |
Cadastrar Novo Lead |
| GET |
/filas_distribuicao_leads |
Listar Filas de Distribuição de Leads |
| GET |
/consultaratendimento |
Administrar lead |
| GET |
/filas_distribuicao_leads |
Listar Filas de Distribuição de Leads |
| GET |
/motivos_cancelamento_lead |
Listar Motivos |
| GET |
/leads_conversoes |
Listar Conversão |
| GET |
lead_tarefas{idTarefa} |
Listar tarefas e visitas dos leads |
| POST |
/lead_tarefas/cadastrar |
Permissões por interação |
| PUT |
/cvio/lead_tarefas/cadastrar |
Permissões por interação |
| GET |
/v1/cv/leads_interacoes |
Administrar Lead |
Pré-cadastro
| Método |
Endpoint |
Permissão |
| POST |
/precadastro |
Cadastrar e Modificar Pré-cadastros |
| GET |
/precadastro/[{idPrecadastroOuDocumento}] |
Listar Pré-cadastros |
Comissões
| Método |
Endpoint |
Permissão |
| GET |
/v1/cv/comissoes |
Listar comissões |
| POST |
/cvio/comissao |
Administrar comissão |
| POST |
/v1/cv/comissoes/alterar-situacao |
Permitir alterar a situação da comissão |
Assistência Técnica
| Método |
Endpoint |
Permissão |
| POST |
/api/v1/cv/assistencia |
Criar nova Assistência |
| GET |
/api/v1/cv/assistencia |
Listar Assistências |
| GET |
/api/v1/cv/assistencia/{idAssistencia} |
Listar Assistências |
| PUT |
/api/v1/cv/assistencia/{idAssistencia} |
Administrar Assistências |
| POST |
/relacionamento/assistencias/idAssistencia}/alterar-situacao/{idSituacao} |
Administrar Assistências |
| GET |
/relacionamento/assistencias/equipes |
Listar Equipes |
| GET |
/relacionamento/assistencia/equipes/{idEquipe}/usuarios |
Listar Usuários da Equipe |
| POST |
/relacionamento /assistencia/{idAssistencia}/itens |
Administrar Assistências |
| POST |
/relacionamento/assistencia/itens/{idItemAssistencia}/alterar-situacao/{idSituacao} |
Administrar Assistências |
| PUT |
/relacionamento /assistencia/{idAssistencia}/itens/{idAssistenciaItem} |
Alterar informações do item |
| DELETE |
/relacionamento /assistencia/{idAssistencia}/itens/{idAssistenciaItem} |
Administrar Assistências |
| GET |
/relacionamento /assistencia/localidade |
Listar Localidades |
| GET |
/relacionamento /assistencia/area-comum |
Listar Áreas |
| GET |
/relacionamento /assistencia/itens-manutencao |
Listar Itens de manutenção |
| POST |
/assistencia/{idAssistencia}/mensagens |
Cadastrar mensagem na assistência |
| POST |
/assistencia/upload-arquivos/{funcionalidade}/{idFuncionalidade} |
Cadastrar mensagem na assistência |
Atendimentos
| Método |
Endpoint |
Permissão |
| POST |
/cvio/atendimento/cadastrar |
Cadastrar e Modificar Atendimentos |
| PUT |
/cvio/atendimento/alterar_situacao |
Cadastrar e Modificar Atendimentos |
| GET |
/cvio/atendimento/listar |
Listar Atendimentos |
| POST |
/cvio/mensagem_atendimento |
Cadastrar e Modificar Atendimentos |
| PUT |
/v1/cv/atendimento/{idAtendimento} |
Cadastrar e Modificar Atendimentos |
| GET |
/v1/cv/tarefas |
Visualizar Tarefas |
| GET |
/v1/cv/tarefas/{idTarefaCriada} |
Visualizar Tarefas |
| POST |
/v1/cv/tarefas/{idTarefaCriada}/encerrar |
Alterar Tarefa |
| POST |
/relacionamento/atendimento/cadastrar |
Cadastrar e Modificar Atendimentos |
| POST |
/relacionamento/atendimento/finalizar/{idAtendimento} |
Cadastrar e Modificar Atendimentos |
Agendamentos - CVBOT
| Método |
Endpoint |
Permissão |
| GET |
/cvbot/assuntos |
Listar assuntos e subassuntos |
| GET |
/cvbot/assuntos/{idAssunto}/sub-assuntos |
Listar assuntos e subassuntos |
| GET |
/cvbot/agendamentos |
Listar Agendamentos |
| POST |
/cvbot/agendamentos |
Cadastrar e Modificar Agendamentos |
| GET |
/cvbot/agendamentos/pessoa/{idPessoa} |
Listar Agendamentos |
| GET |
/cvbot/agendamentos/{idAgendamento}/unidade/{idUnidade}/horarios |
Listar Agendamentos |
| PUT |
/cvbot/agendamentos/{tipo}/cancelar/{id} |
Gerenciar visita / vistoria |
| GET |
/cvbot/agendamentos/todos-agendamentos |
Listar Agendamentos |
| GET |
/cvbot/agendamentos/{tipo}/empreendimento/{idEmpreendimento}/pessoa/{idpessoa} |
Listar Agendamentos |
| GET |
/cvbot/agendamentos/pessoa/{idPessoa}/unidades-disponiveis |
Listar Agendamentos |
| GET |
/cvbot/agendamentos/horarios |
Listar Agendamentos |
⚠️ Importante: a ausência da permissão vinculada resultará em erro 403 – Forbidden.
