1. Como obter os tokens de acesso?
Entre em contato com o seu agente de CS e solicite a criação de um usuário. Lembrando que a solução dispõe de dois ambientes, homologação e produção.
Para produção utilize a URL base https://api.lecupon.com e para Homologação a URL https://api-hmg.lecupon.com
A autenticação da API é feita com o email e o token no atributo auth_token, presente na resposta da requisição de autenticação, Token autenticação. Sugerimos que você crie um usuário exclusivo para integração, (ex: [email protected]) , pois caso você utilize um usuário de consulta e troque a senha, a sua automação pode parar de funcionar.
2. Ao utilizar os endpoints da API, preciso me preocupar com a atualização e a criação de dados que já foram enviados previamente para a api de sincronização?
Não, a API de sincronização da Lecupon entende que se você tentar criar um usuário que já está cadastrado na base de dados, nós iremos atualizar os dados caso alguma coisa tenha sido alterada, ou seja, é uma chamada que cria um novo registro ou atualiza o registro caso o CPF já exista na base. Outro cenário é - caso você tente criar um CPF que já existe na base, porém está como inativo, o sistema irá automaticamente ativá-lo e atualizá-lo, portanto, na maioria das vezes utilizar a API de criação e remoção é o suficiente para cobrir todos os cenários necessários.
3. Quero cobrar uma assinatura mensal do meu cliente, como gerenciar a sincronização deste usuário?
Ao implementar soluções de pagamento para fazer cobranças de mensalidades de seus clientes, você pode implementar nos callbacks do gateway de pagamento às chamadas necessárias para a API, sendo criação/atualização de dados quando o pagamento estiver em dia e a rotina de exclusão da base de usuários autorizados quando o cliente ficar inadimplente. Nesse caso, a sugestão é que seja implementada a API síncrona, pois o acesso é estabelecido de imediato e, por se tratar da gestão de apenas um usuário, terá melhor performance. Caso o seu sistema faça um processamento de lotes de pagamento durante um período, como por exemplo, de madrugada, e você pretende sincronizar o acesso dos usuários em lote, sugerimos utilizar a API assíncrona, com envio de lotes de até 2.000 CPF's por requisição.
4. O produto do meu core business é digital e eu quero integrar o módulo de cupons dentro da minha plataforma, como faço para sincronizar um usuário?
Ao utilizar a API de cuponagem você precisará utilizar o endpoint de sessão para o CPF. Antes de fazer essa requisição de API, certifique-se de que os dados do usuário já foram enviados previamente para a API de sincronização. Caso o acesso do seu usuário aconteça logo após o login em sua plataforma, recomendamos que o CPF deste cliente seja sincronizado de forma unitária através da API síncrona, isso irá garantir que ao solicitar a requisição de sessão a plataforma não receba uma resposta de "Não autorizado"
5. Por que preciso obter uma sessão através do CPF?
O CPF é a chave de identificação única de cada usuário na plataforma. Com ela, registramos e coletamos todos os eventos de navegação e utilização, que são utilizados posteriormente para gerar indicadores e relatórios de comportamento da plataforma. Além disso, o CPF é chave fundamental para o registro de créditos de cashback e, no caso de clientes que permitem que o crédito seja utilizado para saque, garantir que o valor de cashback seja depositado de forma segura apenas em uma conta bancária cujo CPF é o mesmo do usuário titular da conta,trazendo mais segurança para a operação.
6. Meus clientes são CNPJ (Empresa ou MEI) e não possuem CPF, como utilizar a plataforma?
O CPF é a chave de identificação única de cada usuário na plataforma. Caso você esteja utilizando a solução white label, é possível substituir o formulário de cadastro do aplicativo por um formulário próprio. Como sugestão, em casos similares, você poderá implementar um pré cadastro web onde o seu cliente poderá preencher todos os dados pessoais (Nome, email, CPF e inserir o CNPJ da empresa, de forma que você faça a validação dentro da sua estrutura antes de criar o CPF do lado da Lecupon. Ao invés de apresentar o formulário padrão de cadastro quando o cliente baixar o aplicativo, nós iremos apresentar o formulário presente no endereço https://seudominio.com.br/sign_up, por exemplo. Para cenários de integração com a API de cupons você pode criar a mesma jornada, já que você tem total controle de quem será sincronizado com a solução da Lecupon.