API Reference

Resgatar cupom

Nesta seção, você vai conferir os endpoints para fazer os resgates de cupons com exemplos de telas no app que mostram como eles são feitos.

É importante entender que o fluxo de resgate de um cupom vai variar de acordo com cada tipo de resgate. São eles:

Esses são os possíveis valores para o atributo template retornado nos endpoints de Listagem de cupons de uma organização e Listagem de cupons de uma filial.

Confira agora todos os passos que explicam como cada fluxo de resgate funciona.

coupon_code

É o cupom que possui apenas um código, apresentado no momento da compra, e seu fluxo de resgate funciona da seguinte maneira:

  1. Acesso à listagem de cupons, seja de uma marca ou de uma filial;
  2. Acesso aos detalhes do cupom desejado;
  3. A ação de Ver código de resgate, ou ação equivalente em sua aplicação, deve chamar o endpoint de Resgatar cupom com código, que retornará no atributo redeem_code o código de resgate a ser apresentado na loja.

qrcode

Quando falamos do fluxo do resgate de cupom qrcode, as etapas são:

  1. Acesso à listagem de cupons, que pode ser de uma marca ou de uma filial;
  2. Acesso aos detalhes do cupom desejado;
  3. A ação de Ir para o QR Code, ou ação equivalente em sua aplicação, deve abrir a tela para leitura do QR Code pela câmera do dispositivo do usuário.
  4. A leitura do QR Code irá retornar uma string neste formato: '{"confirmation_key":"12.345.678/0001-32"}'. Essa string deve ser convertida para JSON e, então, o atributo confirmation_key desse JSON irá conter o CNPJ da filial.
  5. Por fim, deve-se chamar o endpoint de Resgatar cupom QR Code, passando no request body o atributo confirmation_key obtido na etapa anterior, juntamente com o atributo coupon_id.

link

Já o cupom link possui resgate online e pode, ou não, ter um código de resgate. Confira os passos do fluxo de resgate desse tipo de cupom:

  1. Acesso à listagem de cupons de uma marca
  2. Acesso aos detalhes do cupom desejado. Esse endpoint retorna um objeto contendo as informações do cupom, incluindo os seguintes atributos:
    1. code: é o código do resgate. Ele deve ser exibido em sua aplicação caso esteja preenchido, isto é, se a API retornar um valor diferente de vazio "" e diferente de null
    2. activation_url: é a URL para ativação do cupom e de redirecionamento para a loja online. O usuário deve ser redirecionado para essa URL ao clicar na ação Ir para a loja, Copiar e ir para a loja (caso tenha código de resgate) ou ação equivalente em sua aplicação. Exemplo de URL retornada: https://api-hmg.lecupon.com/api/v1/cupons/123/tickets?mref=456. O método GET nesse endpoint em questão irá retornar o código HTTP 302 para redirecionamento para a loja online.

Abaixo você pode conferir exemplos das telas do cupom online com link para ir à loja e com código mais link.

  • Cupom online com link para ir à loja

  • Cupom online com código e link para ir à loja

default

Dentro de default estão os demais cupons que não se enquadram nos tipos descritos acima como, por exemplo, o cupom do tipo CPF.

Porém, o cupom do tipo CPF não é resgatável e não existe um endpoint para esse tipo de resgate, já que a pessoa precisa apenas apresentar o CPF durante a compra na loja física. Ou seja, o resgate ocorre fora do app.