The Loyaltify API lets your developer connect Loyaltify to your own systems, such as a till, a booking tool or your website. For example, a till can add points automatically after each sale, so your team doesn't need to scan the card.
This guide is for you and your developer: where to find your API key, where the documentation lives and the things worth knowing before you start building.
💡 Good to know: This is part of the Advanced plan. It stops working if you move to a lower plan.
Find your API key
In Loyaltify, click your name at the top right.
Go to Your Profile and copy your API key.
Can't see an API key on your Advanced account? Contact support through live chat and we'll turn it on for you.
⚠️ Treat your API key like a password. Share it only with your developer, and never put it in a website's code or in a link.
Read the documentation
The full API documentation is at api.loyaltify.io/api-docs. A few things your developer should know:
Send the API key in the
X-API-Keyheader with every request.Use the live address,
api.loyaltify.io.Opening an endpoint in your browser shows "Unauthorized". That's expected, because the browser doesn't send your key.
What you can do with the API
Sign up customers through one of your sign-up forms, for example from your own website or app. The response includes the customer's Apple Wallet and Google Wallet card links.
Look up customers and their transactions, update their details or delete them.
Add stamps, points or credit, or redeem rewards with a scan request, just like your team does in the Store app. What you send depends on the card type.
Good to know
The QR code on each card always has the same format:
lytf-, your store ID, then the customer's ID. A till can read it to find the right customer.Each customer has two IDs: a short customer ID (the one on their card and in webhooks) and an internal number used by some API requests. The documentation shows how to look one up from the other.
Need your store ID? Contact support through live chat.
Several locations or tills can all use the same API key.
Want to know when something happens? Use Webhooks to get a message whenever a customer joins or earns.
💡 Would you like us to build it? We also build custom integrations, quoted separately. Contact us through live chat with the system you use and what you'd like to happen.
Need a hand?
We're here to help!
If you have any questions about the API, reach out to us via live chat inside Loyaltify, or use the chat button at the bottom right of this page. Our team will be happy to help.