A API da Loyaltify permite ao seu programador ligar a Loyaltify aos seus próprios sistemas, como uma caixa, uma ferramenta de reservas ou o seu site. Por exemplo, uma caixa pode adicionar pontos automaticamente após cada venda, para que a sua equipa não precise de digitalizar o cartão.
Este guia é para si e para o seu programador: onde encontrar a sua chave de API, onde está a documentação e o que convém saber antes de começar a desenvolver.
💡 Convém saber: Esta funcionalidade faz parte do plano Advanced. Deixa de funcionar se mudar para um plano inferior.
Encontre a sua chave de API
Na Loyaltify, clique no seu nome no canto superior direito.
Aceda a O seu perfil e copie a sua chave de API.
Não vê uma chave de API na sua conta Advanced? Contacte o apoio através do chat ao vivo e nós ativamo-la por si.
⚠️ Trate a sua chave de API como uma palavra-passe. Partilhe-a apenas com o seu programador e nunca a coloque no código de um site nem num link.
Consulte a documentação
A documentação completa da API está em api.loyaltify.io/api-docs. Algumas coisas que o seu programador deve saber:
Envie a chave de API no cabeçalho
X-API-Keyem todos os pedidos.Use o endereço de produção,
api.loyaltify.io.Se abrir um endpoint no navegador, aparece «Unauthorized». É normal, porque o navegador não envia a sua chave.
O que pode fazer com a API
Registar clientes através de um dos seus formulários de registo, por exemplo a partir do seu site ou da sua app. A resposta inclui os links do cartão do cliente para o Apple Wallet e o Google Wallet.
Consultar clientes e as respetivas transações, atualizar os dados ou eliminá-los.
Adicionar selos, pontos ou crédito, ou resgatar recompensas com um pedido de digitalização, tal como a sua equipa faz na app Loyaltify Store. O que envia depende do tipo de cartão.
Convém saber
O código QR de cada cartão tem sempre o mesmo formato:
lytf-, o ID da sua loja e, depois, o ID do cliente. Uma caixa pode lê-lo para encontrar o cliente certo.Cada cliente tem dois IDs: um ID de cliente curto (o que aparece no cartão e nos webhooks) e um número interno usado por alguns pedidos da API. A documentação mostra como obter um a partir do outro.
Precisa do ID da sua loja? Contacte o apoio através do chat ao vivo.
Várias localizações ou caixas podem usar a mesma chave de API.
Quer saber quando algo acontece? Use os Webhooks para receber uma mensagem sempre que um cliente adere ou ganha pontos.
💡 Prefere que sejamos nós a criá-la? Também criamos integrações personalizadas, com orçamento à parte. Contacte-nos através do chat ao vivo, indicando o sistema que usa e o que gostaria que acontecesse.
Precisa de ajuda?
Estamos aqui para ajudar!
Se tiver alguma dúvida sobre a API, fale connosco através do chat ao vivo na Loyaltify ou utilize o botão de chat no canto inferior direito desta página. A nossa equipa terá todo o gosto em ajudar.