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

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": "[email protected]",
  "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": [
    "[email protected]"
  ],
  "emailsBCC": [
    "[email protected]"
  ],
  "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": [
    "[email protected]"
  ],
  "emailsBCC": [
    "[email protected]"
  ],
  "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!