Quem somos?
A Alloyal é uma loyalty tech que entrega mais vendas, engajamento e retenção de usuários para empresas por meio de ferramentas personalizadas de fidelidade como programas de pontos, cashback, sorteio, clubes de descontos, segmentação de clientes e mais.
Introdução
A API da Alloyal é a ponte que conecta seu sistema à nossa plataforma de clubes de vantagens e programas de fidelidade. Ela foi projetada para ser flexível, segura e fácil de integrar, permitindo que você desenvolva soluções personalizadas que maximizam o engajamento e os benefícios para seus usuários.
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 Síncrona
A atualização de dados síncrona é a melhor escolha para cenários que exigem acesso imediato à plataforma do cliente, como a criação de uma nova conta de usuário via API.
Por exemplo, em integrações com plataformas de cupons, é comum que o sistema precise autorizar um CPF na base de usuários e, em seguida, capturar uma sessão de usuário utilizando a API de sessão. Nesses casos, a abordagem assíncrona pode gerar problemas: o envio dos dados para uma fila de processamento pode atrasar o cadastro do usuário, resultando em respostas como "CPF não autorizado".
Ao optar pela atualização síncrona, o processo é executado em tempo real, garantindo que os dados estejam disponíveis imediatamente, reduzindo atrasos e melhorando a experiência do usuário.
Para saber mais, veja os endpoints da API correspondentes a sincronização de usuários em:
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 CPFs precisam ser sincronizados com a base de dados da Alloyal.
A API da Alloyal 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 Alloyal, 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:
Autenticação
A autenticação é um passo essencial para obter os tokens de acesso necessários para as requisições desta API. Esses tokens devem ser incluídos nos headers de todas as chamadas subsequentes. Utilize essas credenciais no endpoint de autenticação para gerar os tokens.
Na resposta, você receberá os dois tokens obrigatórios:
X-ClientEmployee-EmailX-ClientEmployee-Token
Esses tokens deverão ser adicionados aos headers de todas as requisições futuras para autenticação e autorização na API.
Atenção
Para esta API NÃO é necessário adicionar o header Bearer às requisições.