API CPLUG
API ATUAL
O que é uma API?
API é a sigla para Application Programming Interface, ou em português, Interface de Programação de Aplicações.
De forma simples, uma API é um conjunto de regras que permite que dois sistemas diferentes se comuniquem entre si.
Ela funciona como uma ponte, permitindo que softwares troquem informações de forma padronizada, segura e automatizada e sem necessidade de interação manual.
Por meio da API, é possível, por exemplo, cadastrar um cliente, consultar produtos em estoque ou enviar informações de vendas de forma direta entre sistemas diferentes, como um ERP e uma plataforma de e-commerce.
Funcionalidades da API atual da CPlug
Documentação API atual -> http://cdn.connectplug.com.br/apidoc/index.html
Nossa API permite que outros sistemas se conectem ao ecossistema CPlug para consultar, cadastrar, atualizar ou excluir dados. Veja tudo que ela já consegue fazer hoje:
Clientes e Categorias
-
Clientes: cadastrar, listar, visualizar, atualizar e excluir.
-
Categorias de clientes: mesmas funções acima.
Crédito do Cliente
-
Adicionar ou remover crédito.
-
Consultar histórico de transações.
Formas de Pagamento
-
Consultar todas as formas de pagamento disponíveis no sistema.
Produtos e Cadastros Relacionados
-
Produtos: listar, consultar saldo com atributos, exportar dados.
-
Atributos de Produto: cadastrar, listar, atualizar, excluir.
-
Opções de Atributo: cadastrar, atualizar, excluir.
-
Componentes de Opções: cadastrar, visualizar, excluir.
-
Categorias de Produto: cadastrar, atualizar, excluir.
-
Códigos de Barras: listar todos.
-
Fornecedores: listar e visualizar por nome.
Vendas e Pedidos
-
Vendas: listar, ver detalhes, enviar NFe/SAT por e-mail, consultar nota, atualizar dados do SAT.
-
Pedidos de Venda: listar, ver detalhes e cadastrar novos.
Como liberar o uso da API atual?
Simples: basta solicitar a liberação diretamente pelo painel Admin do sistema.
Valor
A liberação da API tem um custo único de R$ 299/mês.
API NOVA (3.0)
O que é uma API?
API significa Application Programming Interface, ou Interface de Programação de Aplicações.
De forma objetiva, é um conjunto de padrões que permite que dois sistemas diferentes se comuniquem diretamente, de forma automática, segura e organizada.
Na prática, a API permite que desenvolvedores criem integrações com o sistema da CPlug para consultar, cadastrar, atualizar ou excluir dados, como clientes, produtos, vendas, entre outros.
Introdução
A API da ConnectPlug permite que parceiros utilizem diversos recursos da plataforma, como gerenciar lojas, pedidos e integrações.
A ConnectPlug oferece soluções para a operação e gestão de vendas, possibilitando integrar PDV/POS ou qualquer outro aplicativo.
Organização da Documentação
A documentação da API está organizada em categorias para facilitar a navegação:
-
Autenticação: Endpoints para obter tokens de acesso
-
Catálogo de Produtos: Gerenciamento de produtos, categorias e unidades
-
Produtos - Funcionalidades Descontinuadas: ⚠ Endpoints que serão removidos em breve
-
Aplicativos: Gerenciamento de aplicativos e disponibilidade de produtos
-
Financeiro: Pagamentos, contas bancárias e transações
-
Vendas: Pedidos, vendas e promoções
-
Estoques: Gerenciamento de estoque e compras
-
Empresa: Configurações da empresa e periféricos
-
Relatórios: Relatórios de vendas e estatística
Acesse a documentação completa aqui:
Documentação API NOVA (3.0)
O que muda na Nova API da CPlug?
A nova API da CPlug foi desenvolvida para atender demandas mais complexas e proporcionar maior controle e segurança nas integrações. Ela não substitui imediatamente a API anterior — ambas seguem ativas, mas com objetivos distintos.
Principais mudanças:
Controle por integrador:
Agora, é necessário cadastrar o desenvolvedor como um integrador, com informações como nome, CNPJ, e-mail de desenvolvimento e telefone. Cada integrador recebe credenciais fixas e exclusivas (Client ID e Client Secret).
Gerenciamento de múltiplas lojas:
Após o cadastro do integrador, as lojas são vinculadas a ele com base no schema e no e-mail do usuário principal da loja, o que permite centralizar o acesso em uma única conta (útil para quem integra várias lojas com um mesmo sistema).
Autenticação mais robusta:
A autenticação é feita via Client ID + Secret + usuário e senha da loja, garantindo maior segurança e rastreabilidade.
Envio de credenciais:
As credenciais são enviadas diretamente por e-mail aos desenvolvedor pelo responsável técnico Cplug.
O e-mail do desenvolvedor é essencial para o recebimento de logs e notificações de atualizações da API.
Funcionalidades da Nova API
A nova API possui todas as funcionalidades da versão anterior e novas funções em constante expansão.
Importante:
Como a nova API está em evolução contínua, é fundamental que o desenvolvedor consulte regularmente a documentação oficial para acompanhar os recursos disponíveis.
Além disso, os desenvolvedores cadastrados recebem por e-mail notificações automáticas com logs de mudança e atualizações da API, garantindo que estejam sempre atualizados com as novidades.
Aqui está a reescrita atualizada do tópico "Como liberar o uso da nova API?" para o Handbook da ConnectPlug, incorporando as atualizações do Portal CPlug Developer apresentadas nas fontes.
Como liberar o uso da nova API (3.0)?
O processo de credenciamento, gestão de acessos e liberação de lojas (tenants) para a API Nova (3.0) é realizado de forma centralizada através do Portal CPlug Developer (developer.cplug.com.br).
Essa estrutura substitui o envio manual por chamados, permitindo que a integradora gerencie suas próprias credenciais, usuários desenvolvedores e solicitações de acesso às lojas.
1. Cadastro da Integradora e Primeiro Acesso
- O desenvolvedor/integradora realiza o cadastro inicial da conta parceira diretamente no portal CPlug Developer (
developer.cplug.com.br). - Após a revisão e aprovação pela equipe interna da ConnectPlug, o responsável técnico pela integradora recebe o e-mail de confirmação e acesso ao portal.
- No painel principal (Dashboard), a integradora tem acesso às suas credenciais exclusivas de integração (Client ID e Client Secret).
- O administrador da integradora pode cadastrar e gerenciar novos usuários desenvolvedores do seu time no menu Usuários do portal.
2. Como Identificar o ID do Tenant (Loja)
Para vincular uma loja à aplicação da integradora, é necessário obter o ID do Tenant referente ao estabelecimento no ERP CPlug:
- Acesse o ERP ConnectPlug da loja contratante.
- No menu lateral, navegue até Configurações > Integrações.
- Clique na aba Integrações via API.
- O campo ID do tenant (ex.:
134262) será exibido na tela. Copie esse número.
3. Solicitando Acesso às Lojas (Tenants)
Com o ID do Tenant em mãos, a integradora faz a solicitação de permissão diretamente no portal:
- Acesse o portal CPlug Developer e navegue até o menu Tenants.
- Clique no botão + Solicitar acesso.
- Insira o ID do Tenant da loja desejada e preencha a justificativa de acesso (ex.: "Integração ERP / Pedidos").
- A solicitação ficará visível na tabela de histórico com o status Em análise.
- Assim que a equipe responsável analisar a requisição, o status será atualizado para Aprovado (ou Recusado), liberando o acesso da aplicação aos endpoints daquela loja.
Valor
A liberação da API (tanto nova quanto antiga) tem um custo de R$ 299,00/mês.