🏁 Bem-vindo à página de documentação das nossas APIs!

🗂️ Detalhando a plataforma.

No menu superior, você encontrará as opções: Home, Documentação (onde você está agora), Tutoriais e Referências de API. Esses quatro menus reúnem tudo o que você precisa para começar a realizar integrações e consumir dados do CV CRM. Vamos iniciar essa jornada por um mundo cheio de oportunidades chamado CV CRM!

🏛️ Arquitetura.

Para simplificar e acelerar o processo de integração entre sistemas, o Construtor de Vendas oferece uma documentação completa de suas APIs, permitindo que você conecte facilmente seu aplicativo ou seu sistema na nossa plataforma ou consuma informações que são importante para você.

Nossas APIs seguem o padrão arquitetônico REST e utilizam o formato JSON, garantindo uma estrutura simples, moderna e fácil de usar. O objetivo é tornar a integração o mais tranquila possível, oferecendo praticidade para quem está desenvolvendo, seja você um(a) desenvolvedor(a) júnior ou sênior.

Com isso, esperamos que você tenha uma experiência incrível e produtiva ao explorar as APIs do Construtor de Vendas!

~

🦮 Guia para autenticar nas nossas apis.

Etapa 1: Como autenticar nas APIS ?

Para utilizar as APIs do CV, é essencial ter um e-mail e um token, ambos indispensáveis para autenticação e autorização de acesso aos recursos. Todas as APIs requerem esses dados como pré-requisito básico. Importante destacar que o e-mail deve estar registrado no mesmo domínio onde os dados serão consumidos.

Etapa 2: Gerando o token de acesso

Para gerar o token, é necessário acessar o cadastro de usuários administrativos no CV CRM e localizar o usuário desejado. Em seguida, clique na opção "Token". Há também a possibilidade de definir uma data de vencimento para o token gerado. Com o e-mail do usuário e o token em mãos, o próximo passo é configurar o endpoint que será consumido.

👍

Artigo sobre geração de token da nossa base de conhecimento

💻 Métodos mais utilizados no CV CRM

GET 🔍

É o método responsável por disponibilizar informações do Construtor de Vendas para o sistema que realizará a integração conosco. Sempre que é preciso somente consultar algumas informações é utilizado o método GET.

POST 🔼

O método POST é utilizado para cadastrar informações no Construtor de Vendas. Em alguns casos, também pode ser empregado para realizar alterações cadastrais dentro do sistema.
Esse método é bastante utilizado para quem deseja Cadastrar um Lead ou Cadastrar um atendimento no CV CRM.

PUT 🔄

O método PUT é utilizado para atualizar informações já existentes no Construtor de Vendas, sendo ideal para casos em que os dados precisam ser substituídos ou modificados integralmente.
Um exemplo prático de uso no CV CRM é a atualização de dados de uma reserva por meio de integração, é utilizado o método PUT para Atualizar reserva.

DELETE 🗑️

É utilizado quando é necessário excluir um registro ou cadastro existente no sistema. Ele é empregado para remover permanentemente recursos específicos, garantindo que informações desnecessárias ou incorretas sejam eliminadas, mantendo o sistema organizado e eficiente. É uma ação definitiva, por isso deve ser usada com cautela para evitar a perda de dados importantes.
Outro exemplo prático de uso é a remoção, via integração, de um item cadastrado em uma solicitação de assistência técnica.

📘

Artigo sobre métodos HTPP do MDN Web Docs.

✅Permissões para utilização das APIS

Para utilizar as APIs do sistema, é necessário que os usuários possuam perfis de acesso com as permissões adequadas para as operações desejadas e que os módulos correspondentes estejam habilitados. As permissões são atribuídas com base nas responsabilidades e funções de cada usuário dentro da organização.

Ao tentar acessar uma API, o sistema verificará se o perfil de acesso do usuário contém as permissões necessárias e se os módulos requeridos estão ativados. Caso alguma dessas condições não seja atendida, o acesso será negado.

Entenda como funcionam as permissões para uso das APIs:

📘

Gerenciamento de Permissões de APIs por Perfil e Módulo

Para entender como funciona os Perfis de acesso:

📘

Configuração de Perfis de Acesso - Painel do Gestor

💬 CVIO o seu maior aliado

Painel de monitoramento

O CVIO é o responsável por registrar as transações relacionadas à entradas e saídas de informações, ou seja, as requisição que são feitas, tanto para inserir um dado no Construtor de Vendas, quanto para consultar um dado. Armazenando toda a comunicação entre o CV CRM e os sistemas integrados a ele.

Nele você poderá consultar as entrada, as saída, transações pendentes, fazer a gestão de tokens, crons e fila de e-mails. Todas as transações são acompanhadas de status, data da requisição, descrição e outros filtros que permitem uma pesquisa precisa e detalhada, otimizando o tempo de análise.

👍

A URL para acessar o CVIO é: https://dominiodocliente.cvcrm.com.br/cvio.

⚠️ Mas fique atento, pois só guardamos as informações das requisições transacionadas no Construtor de Vendas durante 30 dias.

👩🏾‍🏫 Conceitos

API CVDW:

Criada para facilitar o consumo de dados, essa modalidade fornece APIs que permitem a integração com diversas plataformas, como Power BI, MySQL, entre outras. Diferentemente do CVDW Banco, essa solução oferece controle sobre as tabelas consumidas e permite obter dados em tempo real.

📘

Temos uma página totalmente dedicada a explicar e detalhar o funcionamento das APIs do CVDW

Rate Limit:

O rate limit é uma medida essencial para proteger APIs, sistemas e os dados dos usuários. Ele define o número máximo de requisições que um usuário ou aplicação pode realizar em um determinado período, prevenindo sobrecargas no servidor e garantindo o desempenho estável das APIs. Além disso, é uma defesa importante contra abusos, como ataques de negação de serviço (DDoS), que podem comprometer a disponibilidade dos recursos.

Caso o limite seja atingido, o retorno será um código 429 - Too Many Requests e o sistema bloqueará o acesso pelo próximo minuto. Sugerimos não realizar requisições paralelas e/ou adicionar um "sleep" de segundos entre as requisições, como uma boa prática.

🫱🏽‍🫲🏿 Estamos aqui para ajudar!

Se precisar de ajuda, envie um e-mail para o nosso suporte ou, se preferir, entre em contato pelo chat disponível no CV.

👍

Endereço de email do CV CRM: [email protected]

Estamos empolgados por você estar aqui! 💚