Mudança de Nível - Configuração de Trigger na VTEX

1. Gerando Credenciais Criptografadas

Na tela de Credenciais de API, siga os passos abaixo:

1. Crie uma nova credencial privada.
2. Copie o token e a senha gerados.

1. Acesse o site Base64 Guru.
2. No campo de conversão, insira o token e a senha separados por “:”, conforme mostrado na imagem abaixo.

Exemplo: 

IMPORTANTE: A senha utilizada é aquela da geração da CREDENCIAL API. Não utilize sua senha de admin.

1. Aperte o botão “Encode text to Base64”
2. O código gerado será o token e senha criptografados. Salve este código; ele será utilizado posteriormente para autenticar nossa API.

2. Pegando o Id do Tier através de chamada HTTP

Pode ser feito de duas formas:

• Através do painel administrativo da BonifiQ:

  • Acessar o menu “níveis” e no nível desejado clicar em “Configurar”
  • No navegador, no endereço do site, é exibo um número, como abaixo

• No exemplo acima, o Id do tier é 84

• Via API da BonifiQ

  • Fazer chamada de Tiers via chamada da API Privada::
    • https://api.bonifiq.com.br/apidocs/private/index.html?url=/swagger/Private APIs/swagger.json#/Tiers/Tiers_Tiers

3. Configurando o Trigger de mudança de Tier na VTEX

Acesse a tela da VTEX e siga estes passos:

1. Na aba Trigger, adicione um novo trigger e siga as etapas abaixo:

   Passo 1:

   • Selecione o Data Entity como “Customer”.

1. Passo 2:

   • Escolha a opção “A filter attribute is changed”.

1. Passo 3:

   • No campo de atributo, selecione o campo que ativará essa Trigger (por exemplo: “Is Subscription”).
   • Na segunda opção, selecione “Equal to”.
   • No terceiro campo, insira “true” (ou outra opção, de acordo com o seu campo)

2. Na aba Schedule, selecione a opção “Run ASAP”.

3. Na aba If Positive, configure a ação:

   1. Selecione a ação “Send an HTTP request”, onde aparecerá a tela para configuração de envio da requisição.
   2. Preencha os seguintes valores nos campos:
   3. URL: https://api.bonifiq.com.br/v1/pvt/customer/{!email}/changetier
   4. Method: Selecione “POST”.

       

      Headers:  preencha dois campos:

      • Nome: Authorization

      • Value:

        O value será o código de credenciais criptografadas gerado anteriormente. O formato final será:

        "Basic {credenciais_criptografadas}"

        Exemplo:

        Basic dG9rZW4tZXhlbXBsbzpzZW5oYS1leGVtcGxvMTIz

       

      Content as JSON:

      No corpo da requisição, adicione o seguinte conteúdo em formato JSON:

      

       

      4. Configurando o Trigger de remoção de Tier na VTEX

      1. Essa etapa é praticamente a mesma coisa que o processo anterior, porém com pequenas mudanças
      2. Acesse a tela da VTEX e siga estes passos:

      3. Na aba Trigger, adicione um novo trigger e siga as etapas abaixo:

         Passo 1:

         1. Selecione o Data Entity como “Customer”.

      4. Passo 2:

         1. Escolha a opção “A filter attribute is changed”.

      5. Passo 3:

         1. No campo de atributo, selecione “Is Subscription” (ou o campo que se deseja utilizar).
         2. Na segunda opção, selecione “Equal to”.
         3. No terceiro campo, insira “false”.

      6. Na aba Schedule, selecione a opção “Run ASAP”.

      7. Na aba If Positive, configure a ação:

         1. Selecione a ação “Send an HTTP request”, onde aparecerá a tela para configuração de envio da requisição.
         2. Preencha os seguintes valores nos campos:
         3. URL: https://api.bonifiq.com.br/v1/pvt/customer/{!email}/removetier
         4. Method: Selecione “DELETE”.
         5. Headers:  preencha dois campos:

            • Nome: Authorization

            Value:

            O value será o código de credenciais criptografadas gerado anteriormente. O formato final será:

            "Basic {credenciais_criptografadas}"

            Exemplo:

            Basic dG9rZW4tZXhlbXBsbzpzZW5oYS1leGVtcGxvMTIz

            Content as JSON:

            Deixe este campo vazio.

       

      5. Configurando o Trigger de adição de pontos na VTEX

      Você pode criar uma nova trigger seguindo os mesmo passos da mudança de Tier ou pode ir na trigger de mudança e adicionar uma nova Action “Send an HTTP request” na aba de If Positive.

       

• Preencha os seguintes valores nos campos:
• URL:https://api.bonifiq.com.br/v1/pvt/customer/{!email}/points
• Method: Selecione “DELETE”.
• Headers:  preencha dois campos:

  • Nome: Authorization

  • Value:

    O value será o código de credenciais criptografadas gerado anteriormente. O formato final será:

    "Basic {credenciais_criptografadas}"

    Exemplo:

    Basic dG9rZW4tZXhlbXBsbzpzZW5oYS1leGVtcGxvMTIz

    Content as JSON:

    Deixe este campo vazio.

    No corpo da requisição, adicione o seguinte conteúdo em formato JSON:

Nota: Substitua a quantidade de pontos (points) pelo valor desejado.

Importante: os webhook são válidos apenas para os registros criados/alterados após a criação da trigger. Os registros passados que já existem na VTEX não serão enviados para a BonifiQ