Central de Ajuda Venda ERP
  • Administrar Site
    • Como configurar seu site no Ysaas
    • Configurando o apontamento do domínio Your Saas
    • Como acessar a plataforma YSaaS?
    • Como efetuar as configurações do YSaaS?
    • Como efetuar a configuração da Página de ativação
    • Configurando as Funcionalidades do Ysaas
    • Como deixar visível as Integrações no Site Ysaas
    • Como adicionar depoimento de seus clientes no seu Site YSaaS
    • Configurando o Domínio Personalizado no Ysaas
    • Efetuando o apontamento CNAME junto ao Registro.br no Ysaas
    • Efetuando o apontamento CNAME junto ao cPanel no Ysaas
    • Como configurar os Planos no Ysaas
    • Como Personalizar a página Home no Ysaas
    • Efetuando o apontamento CNAME junto LocaWeb no Painel Ysaas
    • Efetuando o apontamento CNAME junto ao UOL no Painel Ysaas
    • Efetuando o apontamento CNAME junto ao Hostinger no Painel Ysaas
    • Efetuando o apontamento CNAME junto ao HostGator no Painel Ysaas
    • Efetuando o apontamento CNAME junto ao GoDaddy no Painel Ysaas
  • Primeiros Passos
    • Guia completo de Primeiros Passos no Painel do Parceiro
    • Como verificar as atualizações do perfil de usuário no Painel do Venda ERP
    • Como utilizar os recursos Social Mídia disponíveis no Canva para parceiro Venda ERP
    • Como utilizar a planilha Modelo de Negócio no Venda ERP
    • Como efetuar alterações na Licença de seu cliente no Venda ERP
    • Como gerar Contratos por Licença no Painel do Venda ERP
    • Como gerar Vendas por Licença no Painel ERP
    • Como Configurar as cores de seu Sistema ERP
    • Manifestando notas contra CNPJ através do Painel Venda ERP
    • Como baixar as DANFES geradas pelos seus clientes no Painel do Venda ERP
    • Correção de Duplicidade de Notas Fiscais
    • Como consultar e acompanhar o potencial de clientes no Venda ERP
    • Quais as ferramentas vinculadas em cada módulo disponível para a criação de seus Planos
    • Como configurar as imagens para o seu ERP
    • Configurando o White Label e o Dominio no seu ERP
    • Como ter acesso ao Curso EAD?
    • Como habilitar o Recaptcha para tela de login
    • Principais ambientes disponíveis para você que é parceiro Venda ERP
    • Como preencher o formulário de auxílio Marketing?
    • Como assinar o contrato de adesão?
    • Quais os recursos presentes na Dashboard de Parceiro do Venda ERP
    • Primeiros Passos do Parceiro
    • Pilares para um bom Atendimento
    • Como acessar o Sistema ERP
  • Marketing
    • Marketing para e-commerce: faça uma boa estratégia
    • ERP pode ajudar a lucrar na Black Friday?
    • Sistema em nuvem para novos negócios: vantagens, benefícios e muito mais!
    • Aumente a produtividade da sua empresa já!
    • E-mail marketing alavancando suas venda
    • Black Friday: como vender mais?
    • Como gerir contas a pagar?
    • UX: o que é e como aplicar para melhorar suas vendas?
    • Quais as vantagens de empreender usando um ERP?
    • Dicas para realizar a cobrança de um cliente que está com um valor pendente.
    • Fluxo de caixa: 4 dicas para gerenciar seu dinheiro.
    • Técnicas de Negociação
    • A importância da satisfação do cliente
    • Dicas para seu estoque não se transformar em transtorno.
    • Ainda com dúvidas sobre certificado digital?
    • Habilidades empreendedoras que você deve ter
    • Data Analytics, como a ferramenta ajuda nas vendas?
    • Suporte qualificado, veja as melhores técnicas para atender seu cliente!
    • Crie seu funil de vendas e feche mais clientes todos os dias!
    • Prospecção ativa: como captar clientes e aumentar seus ganhos
    • Entenda o que é e como trabalhar o marketing orgânico
    • Dicas indispensáveis para divulgar sua empresa utilizando as redes sociais
    • 3 dicas para Começar a Empreender
    • Estratégias para dominar o mercado
    • Blinde sua empresa de crises: dicas de gerenciamento
    • Modelos de materiais para utilizar em sua empresa
  • Conhecimento Geral
    • Como gerar Etiquetas utilizando o Excel no BarTender
    • Gerando etiquetas através do BarTender 2016
    • Como instalar o BarTender 2016 para impressão de etiquetas
    • Como funciona o recurso Discador Web no Venda ERP?
    • Como criar aplicativo Marketplace no Venda ERP
    • Configurando o apontamento de seu domínio Personalizado
    • Como realizar o backup de licenças no Venda ERP
    • Configurando o Servidor do Gmail no Painel do Venda ERP
    • Documentação para utilização da API para o Sistema ERP
    • Strings disponibilizadas pela API do Venda ERP
    • Entenda o sistema tributário no Brasil
    • Conheça NFCe em SP e como utilizar
    • Como ter acesso aos dados do Suporte no Painel do Venda ERP
    • Quais Windows os aplicativos do Venda opera
    • Notificação automática de cobrança
    • Como abrir chamado junto ao Suporte do Venda ERP
    • Como instalar o formato PFX no certificado A1
    • Como integrar TEF no Venda ERP
    • Treinamento para Parceiros
    • Quais as informações que são necessárias utilizar na API
    • Como é gerado o repasse do Venda ERP
    • Solicitação de emissão de documentos fiscais junto ao Paraná- PR
    • Como carregar o comprovante de pagamento no Venda ERP
    • Planos de adesão em novas contratações junto ao Venda ERP
    • Como efetuar o apontamento CNAME na sua conta WIX
    • Como efetuar o apontamento CNAME na sua conta do Registro Br
    • Como efetuar o apontamento CNAME na sua conta LocaWeb
    • Como efetuar o apontamento CNAME na sua conta Hostinger
    • Não foi possível criar um canal seguro para SSL/TLS
    • O que acontece com o acesso após reincidir o contrato junto ao Venda ERP?
    • Como baixar o XML de notas em edição no ERP
    • Retorno MDFe: XML mal formato - Na error occurred while paring EntityName. Line 1, position 1083
    • Tabela de valores de repasse
    • Gerando a primeira licença de contratação Painel de Parceiro
    • Como efetuar o apontamento CNAME na sua conta da Cloudflare
    • Como efetuar o apontamento CNAME na sua conta da HostGator
    • Como efetuar o apontamento CNAME na sua conta da GoDaddy
    • Como efetuar o apontamento CNAME junto ao cPanel
    • Como efetuar o apontamento CNAME junto ao UOL
    • Utilizando o Mongo DB Compass
    • Integração TEF HUB
    • Documentação API para utilização no Painel de Parceiro
    • Como emitir NFC-e pela empresa de SC no Sistema ERP
    • Politica de Privacidade do Gmail
    • Termos de Serviço do Gmail
    • Informações sobre as licenças Isentas de repasse
    • Erro ao logar no ERP: Usuário e Senha incorretos
    • Entendendo o Cálculo do ICMS e do ICMS por Substituição Tributária (ICMS-ST)
    • CST 00 - Tributada Integralmente
    • CST 10 - Tributada e com cobrança do ICMS por substituição tributária
    • CST 20 - Com Redução da Base de Cálculo
    • CST 30 - Isenta/Não Tributada e com Cobrança do ICMS por Substituição Tributária
    • CST 40 - Isenta
    • CST 41 - Não Tributada
    • CST 50 - Suspensão
    • CST 51 - ICMS Diferimento
    • CST 60 - ICMS cobrado anteriormente por substituição tributária
    • CST 70 - Com Redução da Base de Cálculo e Cobrança do ICMS por Substituição Tributária
    • CST 90 - Outros
    • Como estar alterando os dados da licença de cliente no Painel de Parceiro
    • Criando licenças de Experiência através da API
    • Ativando VPN no navegador
  • Painel
    • Gerando Etiquetas Personalizadas
    • Como criar Telas Customizadas no ERP
    • Erro ao excluir lançamento de uma licença gerada no Painel
    • Homologando Notas de Serviços no Painel
    • Como acessar a base de seu cliente usando o link temporário?
    • A conta do meu cliente esta como excluída, como recuperar?
    • Como adicionar as Lojas Virtuais nas Licenças
    • Como restaurar Backups no Painel do Venda ERP
    • Como Criar uma Licença do Tipo Demonstração
    • Como dar acesso ao contador junto ao Painel
    • Como visualizar a cobrança de repasse no Painel do Venda ERP
    • Como vincular um Menu Personalizado com uma licença no Venda ERP
    • Como habilitar token para o cliente no Painel do Venda ERP
    • Como funciona a tela de alterações de licenças no Painel do Venda ERP
    • Como enviar os documentos fiscais automaticamente a Contabilidade
    • Como configurar o dashboard do sistema no Venda ERP
    • Como importar o Certificado Software House para emissão de CF-e SAT no Venda ERP
    • Como configurar plugins do Help Desk no Venda ERP
    • Como configurar os preços dos módulos no Venda ERP
    • Como configurar o SAT na base do cliente do Venda ERP
    • Como utilizar o Marktpleace do Venda ERP
    • Integração com a API do Venda ERP
    • Nova Dashboard do Painel
    • Como criar uma licença de Contratação no Painel
    • Como configurar a PagHiper no seu Painel
    • Como dar acesso ao Banco de Dados MongoDB para usuários
    • Como adicionar TAGS no Header e editar o arquivo CSS com alterações na Interface do Sistema ERP
    • Planos de backup para bancos de dados.
    • Como configurar o seu servidor de e-mails no painel do Venda ERP
    • Como personalizar a Dashboard do Sistema de seus clientes
    • Como consultar repasses no painel de parceiros do Venda ERP
    • Como alterar a senha de acesso do parceiro do Venda ERP
    • Como solicitar a emissão de NFSe no painel do Venda ERP
    • Como configurar planos e preços no painel do Venda ERP
    • Como configurar o responsável técnico de notas fiscais no painel do Venda ERP
    • Como configurar sua tela de login no painel do Venda ERP
    • Como configurar os recebimentos no painel do Venda ERP
    • Como realizar a Integração com o Pipedrive no Venda ERP
    • Como configurar o Servidor de e-mail do Hotmail
    • Como ocultar a Universidade EAD na plataforma de seus clientes
    • Como colocar o Menu Lateral do ERP da Horizontal
    • Duração das licenças de contratação
    • Como alterar a senha de acesso de Cliente no Painel do Venda ERP
    • Como gerar o Token para o Assinador NFe
    • Como dar acesso ao banco de dados para gerar etiquetas
    • Como disponibilizar a Central de Ajuda no Offline
    • Como Permitir o Acesso do Usuário ao Painel no Venda ERP
    • Chamado Técnico junto ao Venda ERP
    • Gerando o repasse de licenças no Painel do Parceiro
    • Integrando o MercadoPago junto ao Painel de Parceiro
    • Ativando Estado Contingência para emissão de notas dentro do Painel
    • Como estar isentando as Licenças disponibilizadas em seu Contrato junto ao Venda ERP
    • Como criar uma licença de Experiência no Painel do Parceiro
    • Gerando o Token Offline
    • Gerando o Token Mobi
    • Como criar o Menu Personalizado no Painel de Parceiro
    • Validação de dados junto ao Venda ERP
    • Carteira de valores no Painel do Parceiro
    • Login com autenticação multi-fator (MFA)
    • Repasse sendo apresentado na criação de licenças
    • Licença Isenta gerando cobrança de repasse
    • Como utilizar o Saldo da Carteira para quitação de repasse
    • Utilizando o Saldo de Carteiras nas Renovações Automáticas
    • Painel de licenças do Venda ERP
    • Solicitando Customização através do Painel do Parceiro
    • Integração com o SERASA
    • Utilizando Checkout para quitação de repasses
    • Revendo aplicativos personalizados no Painel do Parceiro
    • Qual arquivo de backup pode ser importado no Venda ERP?
    • Renovação automática de licenças no Painel do Parceiro
    • Dados da listagem da licença no Painel do Parceiro
    • Gerenciamento dos APP's utilizados por outros parceiros
    • Disponibilizando aplicativos de outros parceiros aos meus clientes
    • Armazenamento de dados
  • 360 chat
    • Criando uma conta Teste junto ao 360chat
    • Integrando o WhatsApp
    • Cadastrando clientes através do Painel do Parceiro
    • Vinculando licenças dos cliente aos Parceiros no 360Chat
    • Autoatendimento no 360Chat
Powered by GitBook
On this page
  • /api/Experiencias
  • /api/Experiencias/{email}/enviar-codigo/email
  • /api/Experiencias/{email}/enviar-codigo/whatsapp
  • /api/Experiencias/{email}/validar-codigo/{token}
  • Token API
  • Testando a aplicação
  • /api/Experiencias
  • /api/Experiencias/{email}/enviar-codigo/email
  • /api/Experiencias/{email}/enviar-codigo/whatsapp
  • /api/Experiencias/{email}/validar-codigo/{token}
  1. Conhecimento Geral

Criando licenças de Experiência através da API

PreviousComo estar alterando os dados da licença de cliente no Painel de ParceiroNextAtivando VPN no navegador

Last updated 2 months ago

Para tornar o processo de criação de licenças no Painel de Parceiro ainda mais ágil e eficiente, a equipe do Venda ERP agora oferece aos parceiros um método específico para a criação de licenças diretamente através da nossa API. Essa funcionalidade permite a automação e integração do processo de emissão de licenças de forma externa, garantindo mais praticidade e eficiência no gerenciamento das soluções.

/api/Experiencias

O processo de criação de uma nova licença de experiência tem início por meio do método API/Experiências. Durante essa etapa, os dados fornecidos são validados, e um token de confirmação de acesso é gerado. Esse token deve ser enviado ao cliente para assegurar a autenticidade da solicitação e garantir que não se trata de uma ação automatizada por robôs.

As informações a serem preenchidas para criação de uma nova licença são:

{
  "email": "string",
  "telefone": "string",
  "nome": "string",
  "senha": "string",
  "cnpj": "string"
}

/api/Experiencias/{email}/enviar-codigo/email

Por meio do método enviar-codigo/email, o sistema realiza o envio do token de ativação para o e-mail informado na licença. O remetente do e-mail e o servidor SMTP utilizados são os mesmos configurados no Painel do Parceiro. Além disso, o conteúdo da mensagem pode ser personalizado, permitindo o envio de um texto em formato HTML, incluindo as tags de substituição correspondentes.

Os campos de Título, Texto da Mensagem e respectivas TAGS de substituição de valores, são:

{
  "tituloEmail": "string",
  "corpoMensagem": "string",
  "emailsCC": [
    "string"
  ],
  "emailsBCC": [
    "string"
  ],
  "replacesCodigoAtivacao": {
    "chaveParaEmail": "string",
    "chaveParaTelefone": "string",
    "chaveParaNome": "string",
    "chaveParaCNPJ": "string",
    "chaveParaToken": "string"
  }
}

/api/Experiencias/{email}/enviar-codigo/whatsapp

Por meio do método enviar-codigo/whatsapp, o sistema realiza o envio do token de ativação para o número de WhatsApp informado na licença. Esse processo utiliza a integração do WhatsApp previamente configurada no cadastro da empresa no Sistema ERP do Parceiro. O conteúdo da mensagem pode ser personalizado, permitindo o envio de um texto com a formatação desejada e com as respectivas tags de substituição.

{
  "tituloEmail": "string",
  "corpoMensagem": "string",
  "emailsCC": [
    "string"
  ],
  "emailsBCC": [
    "string"
  ],
  "replacesCodigoAtivacao": {
    "chaveParaEmail": "string",
    "chaveParaTelefone": "string",
    "chaveParaNome": "string",
    "chaveParaCNPJ": "string",
    "chaveParaToken": "string"
  }
}

/api/Experiencias/{email}/validar-codigo/{token}

O método finalizar-ativacao tem como objetivo concluir o processo de ativação da licença. Caso o token de ativação seja válido, a nova licença de experiência será registrada no sistema. Além disso, um e-mail de confirmação será enviado automaticamente para o cliente, e o método retornará o link de acesso ao sistema.

Token API

Para utilização dessa funcionalidade disponibilizada, é necessário possuir o Token API gerado no painel do parceiro. Para isso, é necessário acessar menu lateral Tokens e em seguida API Sistema

Ao clicar em novo, será disponibilizado os seguintes campos:

Nome Token: informe API; Nome Responsável: informe API; E-mail Responsável: insira o e-mail do usuário administrador do parceiro; Telefone Responsável: descreve o número de telefone do seu cliente; E-mail Administrador Conta: insira o e-mail do usuário administrador do parceiro;

Então, será disponibilizado o token para utilização da API.

Testando a aplicação

Em nossa Swagger, é possível realizar testes para validar o comportamento da API em integração com o Painel do Parceiro.

Através dessa documentação interativa, os parceiros podem:

  • Executar requisições diretamente na API, simulando diferentes cenários de uso.

  • Visualizar respostas em tempo real, analisando os dados retornados e validando sua estrutura.

  • Testar diferentes parâmetros e métodos, garantindo que a comunicação entre a API e o Painel do Parceiro ocorra corretamente.

  • Identificar possíveis ajustes antes da implementação final, otimizando o processo de integração.

O uso da Swagger facilita a compreensão da API e reduz o tempo necessário para testes e ajustes, tornando o desenvolvimento mais eficiente e assertivo.

Com isso, para efetuar os testes clique em Authorize , no canto superior direito da tela

Onde os campos relacionados a utilização da API serão disponibilizados para preenchimento

As informações do Token API gerado no Painel de parceiro, serão preenchidas em seus determinados campos na Swagger. Onde, após preenchido os dados será necessário clicar em Authorize de cada campo, ficando assim, salvo os dados para todos os métodos disponibilizados para utilização.

Feito isso, basta fechar a janela aberta e iniciar os testes, clique em Try it out

/api/Experiencias

Substitua os campos com as informações desejadas, exemplo:

{
  "email": "slavomir48@uorak.com",
  "telefone": "51997066490",
  "nome": "API Painel",
  "senha": "123456",
  "cnpj": "0378883000192"
}

Preenchidos os campos, clique em Execute

Ao executar as informação, será retornado a seguinte informação:

DADOS REGISTRADOS COM SUCESSO, AGUARDANDO VALIDAÇÃO DO TOKEN PARA CRIAR O ACESSO

/api/Experiencias/{email}/enviar-codigo/email

Substitua os campos com as informações desejadas. Informe inicialmente o e-mail informado na ativação da licença

Após isso, preencha as informações do JSON a ser utilizado, exemplo:

{
  "tituloEmail": "Licença de Experiência",
  "corpoMensagem": "Olá ##nome##, bem vindo a empresa Venda ERP.
Segue seu token de validação
##e-mail##
##token##",
  "emailsCC": [
    "slavomir48@uorak.com"
  ],
  "emailsBCC": [
    "jennifer@vendaerp.com.br"
  ],
  "replacesCodigoAtivacao": {
    "chaveParaEmail": "##e-mail##",
    "chaveParaTelefone": "##telefone##",
    "chaveParaNome": "##nome##",
    "chaveParaCNPJ": "##CNPJ##",
    "chaveParaToken": "##token##"
  }
}

Neste método será criada as tags de substituição, ou seja, em replacesCodigoAtivacao é possível visualizar as informações que podem ser utilizadas no Título e corpo de Texto do e-mail que será enviado.

Exemplo:

"chaveParaEmail": "##e-mail##",
"chaveParaTelefone": "##telefone##",
"chaveParaNome": "##nome##",
"chaveParaCNPJ": "##CNPJ##",
"chaveParaToken": "##token##"

Possuindo as tags de informação, basta criar seu título e corpo de texto, utilizando as tags que foram criadas e destinadas para as informações.

Preenchidos os campos, clique em Execute

Ao executar as informação, será retornado a seguinte informação:

Email enviado com sucesso

Então, na caixa de e-mail será recebido as informações, as quais oram configuradas

/api/Experiencias/{email}/enviar-codigo/whatsapp

Substitua os campos com as informações desejadas, para que seja enviado os dados via WhatsApp também. Informe inicialmente o e-mail informado na ativação da licença

Após isso, preencha as informações do JSON a ser utilizado, exemplo:

{
  "tituloEmail": "Licença de Experiência",
  "corpoMensagem": "Olá ##nome##, bem vindo a empresa Venda ERP.
Segue seu token de validação
##e-mail##
##token##",
  "emailsCC": [
    "slavomir48@uorak.com"
  ],
  "emailsBCC": [
    "jennifer@vendaerp.com.br"
  ],
  "replacesCodigoAtivacao": {
    "chaveParaEmail": "##e-mail##",
    "chaveParaTelefone": "##telefone##",
    "chaveParaNome": "##nome##",
    "chaveParaCNPJ": "##CNPJ##",
    "chaveParaToken": "##token##"
  }
}

Lembrando que, para utilização desse método é necessário o Parceiro possuir configurado em seu Sistema ERP, junto ao Cadastro da Empresa na aba Automações de Cobrança, a integração junto a Ultramsg ou GBTalk.

Caso não possuam configurado, será retornado a seguinte mensagem:

Possuindo as configurações necessárias para envio das informações via WhatsApp, será enviado o texto a qual foi configurado junto ao JSON com as respectivas TAGS.

/api/Experiencias/{email}/validar-codigo/{token}

Este método, será responsável pela validação do token gerado para acesso a plataforma de experiência do ERP.

Substitua os campos com as informações que foram enviadas por e-mail ou WhatsApp, exemplo:

Onde será retornado com o link de acesso a plataforma de experiência do ERP

Compreendendo a utilização da API do Painel do Parceiro e suas funcionalidades, o parceiro poderá desenvolver sua própria integração para a criação de licenças de teste em sua plataforma. Essa estratégia possibilita um aumento significativo na captação de leads, automatizando o processo e otimizando o fluxo de geração de novas licenças.

Uma vez implementado o código de comunicação com a API, os parceiros poderão utilizá-lo para integração com diferentes plataformas, incluindo sites e ferramentas de automação. Um exemplo prático dessa aplicação é a integração com a Zapier, permitindo que o JSON gerado pela API seja utilizado para se comunicar com diversas outras plataformas, ampliando as possibilidades de automação e potencializando a captura de novas licenças de forma eficiente e escalável.

Agora é com você, aproveite ao máximo as oportunidades do Venda ERP! Esperamos que este artigo tenha esclarecido suas dúvidas e que te ajude a aproveitar ainda mais as funcionalidades disponíveis. Restou alguma dúvida? Entre em contato com o nosso suporte para maiores informações!