Utilização da API de sincronismo de usuários
Introdução
A sincronização de usuários permite definir como e quando um determinado cliente, pessoa física poderá ter acesso à plataforma. A operação de sincronização de base antecede a criação de contas de novos usuários na plataforma, portanto, o ato de criar e remover convites ou acessos utilizando a API de sincronização refere-se unicamente a ação de permitir ou remover permissões de autorização de acesso à plataforma.
Um usuário que tem sua permissão removida através do uso das APIs de sincronização não tem sua conta ou histórico de uso removidos da plataforma. Caso esse usuário tenha o CPF sincronizado novamente, ele terá novamente acesso à plataforma e seus dados de conta permanecerão inalterados.
Atualização de dados Assíncrona
A atualização de dados assíncrona, é a implementação adequada de APIs para quando um lote de dados de CPF's, precisam ser sincronizado com a base de dados da Lecupon. A API da Lecupon permite até 2.000 inserções por chamada.
Caso precise sincronizar um número grande de usuários em uma primeira integração, você pode fazer uma implementação técnica que seja capaz de enviar lotes de 2 mil usuários até o término da base. Por ser assíncrona, os dados entrarão em uma fila de processamento de dados da Lecupon, podendo levar alguns minutos para serem sincronizados em sua totalidade.
Essa implementação é ideal para rotinas iniciais de carregamento e clientes que possuem grandes quantidades de alteração de lotes, através de rotinas que podem ser processadas em horários de menor pico de utilização de seus sistemas.
Para saber mais, veja os endpoint da API correspondentes a sincronização assíncrona de usuários em: Criar usuários em lote e Deletar usuário em lote
Atualização de dados Síncrona
A atualização de dados síncrona é ideal para cenários que precisam conceder acesso imediato à plataforma do cliente como, por exemplo, a criação de uma nova conta de usuário por meio de API.
Casos como, clientes que utilizam a plataforma de cupons através de integração, irão criar processos que podem autorizar o CPF na base de usuários e imediatamente capturarem uma sessão de usuários através da API de sessão da API de cupons. Nesse caso, fazer o envio de dados de forma assíncrona fará com que o seu sistema receba uma resposta de "CPF não autorizado", pois o cadastro do usuário pode ter entrado em uma fila de processamento assíncrono e consequentemente o tempo de resposta pode ser maior.
Para saber mais, veja os endpoint da API correspondentes a sincronização de usuários em: Criar usuário e Deletar usuário
Autenticação
A autenticação é necessário para se obter os tokens de acesso, que serão utilizados nos headers das requisições desta API. Para obter as credenciais de email e senha, entre em contato com seu agente de Sucesso do Cliente (CS), e as utilize no endpoint de token de autenticação. A partir da resposta, será obtidos os 2 tokens obrigatórios para todos os outros endpoints, sendo eles, X-ClientEmployee-Email e X-ClientEmployee-Token que deveram ser adicionados aos headers das próximas requisições.
Atenção
Para esta API NÃO é necessário adicionar o header Bearer às requisições.