A API pública do Novus CRM é uma API REST que abre os dados da sua conta para outros sistemas. Com ela você cadastra contatos vindos do seu site, dispara mensagens de WhatsApp pelo ERP, move negócios no funil quando um pedido é faturado ou espelha os tickets em um painel próprio.
Esta seção é técnica. Ela parte do princípio de que alguém vai escrever código. Se você quer usar a plataforma pela tela, comece pelo Guia da plataforma.

​
Endereço base

Todas as chamadas partem de um único endereço:
Os caminhos vêm depois dele, sempre com o prefixo da versão: https://api-publica.cpluschat.com.br/v1/contatodechat.
Este domínio vai mudar para api-publica.novuscrm.com.br. Guarde o endereço base em uma variável de ambiente ou arquivo de configuração, nunca espalhado pelo código, para que a troca seja uma linha só. O aviso vai sair no Changelog da API antes da mudança.

​
Versionamento

A versão atual é a v1 e ela aparece no caminho de todo endpoint. Mudança que quebra contrato entra em uma versão nova. Dentro da v1 só entram adições compatíveis, como um campo novo em uma resposta. Isso tem três consequências na hora de consumir a API:
  • Ignore campos que você não conhece, porque eles vão aparecer.
  • Não dependa da ordem das propriedades de um objeto.
  • Acompanhe o Changelog da API, que registra cada endpoint, campo e comportamento novo.

​
Formato das requisições e respostas

O formato é JSON nos dois sentidos, com Content-Type: application/json. Nas respostas, os nomes dos campos usam PascalCase:
Nas requisições, o nome do campo é lido sem diferenciar maiúsculas de minúsculas. Tanto {"nome": "Maria"} como {"Nome": "Maria"} funcionam. Escolha uma das duas formas e use sempre a mesma, para o seu código não ficar misturado. O significado de cada número das enumerações está em Enumerações.

​
O que existe na API

São 212 endpoints em 28 recursos. Cada endpoint tem a sua própria página nesta mesma aba, com parâmetros, corpo, respostas e um playground para testar na hora. A página Recursos funciona como índice: ela mostra o que cada grupo cobre e leva direto ao endpoint. A maioria dos recursos segue o mesmo desenho: PUT substitui, então campo omitido é apagado. PATCH existe em produtos e tickets e altera apenas o que você enviar. Canais, usuários e vendas são somente leitura, porque esses registros nascem na plataforma.

​
Como começar

Autenticação

Os dois cabeçalhos que toda requisição precisa e como gerar sua chave.

Primeira chamada

Do zero até criar um contato e enviar uma mensagem, em quatro chamadas.

Recursos

Os 28 recursos e o caminho de cada um, com link para o endpoint.

Servidor MCP

Os mesmos dados expostos como ferramentas para agentes de IA.