1. Como obter os tokens de acesso?
Para obter os tokens de acesso, entre em contato com o responsável pela Implantação do seu projeto ou envie um e-mail para [email protected], solicitando a criação de um usuário. Lembre-se que a solução opera em dois ambientes: Homologação e Produção.
- Para Produção, utilize a URL base:
https://api.lecupon.com - Para Homologação, utilize a URL base:
https://api-hmg.lecupon.com
A autenticação da API é realizada com o e-mail e o token retornado no atributo auth_token, presente na resposta do endpoint de autenticação.
Sugerimos criar um usuário exclusivo para integração (exemplo: [email protected]) para evitar interrupções em sua automação. Caso você utilize um usuário de consulta e altere a senha, o processo de integração poderá ser impactado.
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 Alloyal é projetada para gerenciar automaticamente a criação e a atualização de registros.
- Usuário já cadastrado: Caso você tente criar um usuário que já exista na base, a API atualizará automaticamente as informações, caso algum dado tenha sido alterado.
- Usuário inativo: Se o CPF informado já estiver cadastrado, mas com o status "inativo", o sistema irá reativá-lo e atualizar seus dados.
Com essa funcionalidade, normalmente é suficiente utilizar a API de criação e remoção de dados para atender a todos os cenários necessários, garantindo eficiência e simplicidade no gerenciamento dos registros.
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 Ativação 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 e você pretende sincronizar o acesso dos usuários em lote, sugerimos utilizar a Ativação Assíncrona, com envio de lotes de até 2.000 CPFs por requisição.
4. 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.
5. 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 Alloyal. 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 LOYALTY você pode criar a mesma jornada, já que você tem total controle de quem será sincronizado com a solução da Alloyal.