Understanding Loyalteez - Concepts Explained
For: Developers who are new to Loyalteez, blockchain, or both.
You'll learn: All the core concepts in plain English, no jargon.
The Big Picture
What is Loyalteez?
Super Simple: Loyalteez lets you reward your users with tokens (called LTZ) for doing things in your app, website, or community.
Think of it like:
- A rewards program (like airline miles)
- But the rewards are real blockchain tokens
- That work across many different apps
- And your users don't need to understand blockchain at all
Why Would I Use This?
Use Loyalteez if you want to:
- Increase user engagement
- Reward loyal customers/community members
- Create a token economy
- Differentiate from competitors
- Give users something valuable
Real examples:
- E-commerce store: Reward purchases with LTZ
- Discord community: Reward active members
- Mobile app: Reward daily usage
- Blog: Reward commenters and subscribers
Core Concepts (Plain English)
1. LTZ Tokens
What they are: Digital tokens (like coins) that have real value.
Think of them like:
- Arcade tokens you earn by playing games
- But these work across many different "arcades" (apps)
- And can be traded or spent on various things
Where they live: On a blockchain (we'll explain this next).
Key fact: Users get these automatically. They don't need to understand what tokens are.
2. Blockchain
What it is: A public ledger (like a shared spreadsheet) that records who owns what.
Why it matters:
- Tokens can't be faked
- Users actually own their tokens (not just points in your database)
- Transparent - anyone can verify ownership
- Works across different apps
What you DON'T need to worry about:
- ❌ How blockchain works technically
- ❌ Writing smart contracts
- ❌ Managing gas fees
- ❌ Wallet setup
What Loyalteez handles for you:
- ✅ All blockchain complexity
- ✅ Gas fees (transaction costs)
- ✅ Wallet creation
- ✅ Smart contract interactions
3. Wallets
What they are: A "digital pocket" that holds LTZ tokens.
Plain English: Like an email address, but for tokens. Each user gets one automatically.
How it works:
- User does something in your app
- You tell Loyalteez "reward this user"
- Loyalteez creates a wallet (if they don't have one)
- Tokens go into their wallet
- Done!
User experience:
- No setup required
- No "connect wallet" button
- No seed phrases to remember
- Just works automatically
4. Events
What they are: Actions users take that you want to track.
Examples:
- User signs up →
user_signupevent - User makes purchase →
purchase_completedevent - User posts comment →
comment_postedevent
How you track them:
// When something happens in your app
fetch('https://api.loyalteez.app/loyalteez-api/manual-event', {
method: 'POST',
body: JSON.stringify({
event: 'user_did_something',
email: '[email protected]'
})
});
That's it! Loyalteez handles the rest.
5. Gas Fees
What they are: Transaction costs on blockchain (like a postage stamp).
Plain English: Every blockchain transaction costs a tiny amount of cryptocurrency. Normally users would need to pay this.
Good news: Loyalteez pays all gas fees for you. Users never see this cost.
Why this matters: Users don't need cryptocurrency to receive rewards!
6. Smart Contracts
What they are: Programs that run on blockchain.
Think of them like:
- A vending machine
- You put in money (input)
- It gives you a snack (output)
- No human needed - it just works automatically
Loyalteez smart contracts:
- Handle token distribution
- Manage perk claims
- Enforce rules
- Track ownership
You don't need to:
- Write smart contracts
- Deploy smart contracts
- Understand Solidity (contract language)
You just: Send HTTP requests to our API. We handle the smart contracts.
How Loyalteez Works (Step by Step)
The Flow
1. User does something in your app
↓
2. Your app tells Loyalteez "give them LTZ"
↓
3. Loyalteez checks if user has a wallet
↓
4. If no wallet: Creates one automatically
If has wallet: Uses existing
↓
5. Loyalteez sends LTZ to user's wallet
↓
6. Transaction recorded on blockchain
↓
7. User has LTZ! 🎉
Real Example: E-commerce Store
Scenario: Customer buys a $50 shirt
What happens:
-
Customer completes purchase in your Shopify store
-
Shopify sends webhook to your server
// Shopify says: "Order created!"
{
customer: { email: "[email protected]" },
total_price: 50.00
} -
Your server calculates reward
const ltzReward = 50; // 1 LTZ per $1 -
Your server calls Loyalteez
fetch('https://api.loyalteez.app/loyalteez-api/manual-event', {
method: 'POST',
body: JSON.stringify({
event: 'purchase_completed',
email: '[email protected]',
metadata: { order_value: 50 }
})
}); -
Loyalteez processes:
- Checks if customer has wallet
- Creates wallet if needed
- Sends 50 LTZ to wallet
- Pays gas fees
- Records on blockchain
-
Customer sees:
- "You earned 50 LTZ!"
- Can spend at marketplace.loyalteez.xyz
Total time: 2-3 seconds
Customer effort: Zero
Your effort: One HTTP request
Key Technologies Explained
HTTP Requests
What: The way computers talk to each other over the internet.
Plain English: Like sending a text message, but between apps.
Example:
// Your app → Loyalteez
fetch('https://api.loyalteez.app/...', {
method: 'POST', // Type of message
body: JSON.stringify({data}) // The message content
});
You already use these: Every time you load a website, post on social media, or send an email.
JSON
What: A way to format data so computers can read it.
Plain English: Like filling out a form with fields and values.
Example:
{
"name": "John",
"age": 30,
"likes": ["pizza", "coding"]
}
Easy to read: Even non-programmers can understand it.
APIs
What: Application Programming Interface - a way for programs to talk to each other.
Plain English: Like a restaurant menu. You don't need to know how to cook. You just order from the menu, and the kitchen handles it.
Loyalteez API:
- You: "Give this user 50 LTZ"
- Loyalteez: "Done! Here's the transaction hash"
Webhooks
What: Automatic notifications when something happens.
Plain English:
- You: "Hey Shopify, when someone buys something, tell me!"
- Shopify: "OK! I'll send you a message every time"
- (Later) Shopify: "Someone just bought a shirt!"
Use for:
- E-commerce (Shopify, WooCommerce)
- Forms (Typeform, Google Forms)
- Payments (Stripe, PayPal)
- Almost everything
Environment Variables
What: Secret values (like passwords) stored separately from your code.
Why: So you don't accidentally share secrets publicly.
Example:
# .env file (never commit to GitHub!)
API_KEY=secret_abc123
BRAND_ID=your_brand_id
// In code, use them like this
const apiKey = process.env.API_KEY;
Common Terms Glossary
Blockchain Terms
| Term | Plain English | Example |
|---|---|---|
| Blockchain | Shared ledger | Like a shared Excel sheet everyone can see |
| Token | Digital coin | Like a Chuck E. Cheese token |
| Wallet | Token container | Like a digital wallet/purse |
| Transaction | Transfer | Moving tokens from A to B |
| Gas Fee | Transaction cost | Like a postage stamp |
| Smart Contract | Automatic program | Like a vending machine |
| Address | Wallet ID | Like an email address |
Developer Terms
| Term | Plain English | Example |
|---|---|---|
| API | Menu of actions | Restaurant menu |
| Endpoint | Specific URL | https://api.loyalteez.app/manual-event |
| HTTP | Internet communication | Text messaging between apps |
| POST | Send data | Submitting a form |
| GET | Retrieve data | Loading a webpage |
| JSON | Data format | Form with fields and values |
| Webhook | Automatic notification | "Ping me when X happens" |
| Event | Something that happened | User signed up, bought item, etc. |
Loyalteez-Specific Terms
| Term | What It Means |
|---|---|
| LTZ | The token users earn (Loyalteez token) |
| Brand ID | Your unique identifier in Loyalteez system |
| Event Handler | The API that receives your events |
| Gas Relayer | The service that pays gas fees for you |
| Partner Portal | Your admin dashboard (partners.loyalteez.app) |
| Perk | Things users can buy with LTZ |
Architecture Overview (Simple)
The 3 Layers
┌─────────────────────────────────────┐
│ YOUR APP (Web, Mobile, Bot) │ ← You control this
│ "User did something! Reward them" │
└──────────────┬──────────────────────┘
│ HTTP Request
↓
┌─────────────────────────────────────┐
│ LOYALTEEZ WORKERS (Cloud) │ ← We handle this
│ "OK! Creating wallet, sending LTZ"│
└──────────────┬──────────────────────┘
│ Smart Contract Call
↓
┌─────────────────────────────────────┐
│ BLOCKCHAIN (Soneium Mainnet) │ ← Automatic
│ "Transaction recorded permanently" │
└─────────────────────────────────────┘
What Each Layer Does
Your App (Layer 1):
- Detects user actions
- Sends HTTP requests to Loyalteez
- Shows rewards to users
- You have full control here
Loyalteez Workers (Layer 2):
- Receives your requests
- Creates wallets automatically
- Sends tokens to users
- Pays gas fees
- We handle this entirely
Blockchain (Layer 3):
- Records transactions permanently
- Ensures tokens can't be faked
- Makes tokens work across apps
- Happens automatically
What You Need to Know vs. What We Handle
✅ You Handle (Easy Stuff)
- Decide what actions to reward
- Send HTTP requests when actions happen
- Show rewards to your users
- Configure reward amounts
❌ We Handle (Hard Stuff)
- Blockchain integration
- Wallet creation
- Gas fee payments
- Smart contract deployment
- Transaction management
- Security
- Scalability
Getting Started Checklist
Prerequisites (Do you have these?)
- An application or website (or planning to build one)
- Way to identify users (email, username, ID)
- Way to detect user actions (events)
- Basic programming knowledge (any language)
If you checked all boxes: You're ready! 🚀
What to Do Next
Step 1: Sign up at partners.loyalteez.app
- Get your Brand ID
- Set up reward rules
Step 2: Choose your integration method:
- Web app? → JavaScript SDK
- Mobile app? → Mobile Guide
- Discord? → Discord Bot
- Other? → Custom Integration
Step 3: Implement (follow the guide)
- Usually takes 15-45 minutes
- Copy-paste code examples
- Test with a few users
Step 4: Launch!
- Monitor analytics in Partner Portal
- Adjust reward amounts as needed
- Watch engagement increase 📈
Common Questions (Beginner-Friendly)
"I don't know blockchain - can I still use this?"
Yes! That's the whole point. You don't need to know blockchain. Just send HTTP requests.
Think of it like using email - you don't need to understand SMTP protocol to send emails.
"Do my users need crypto wallets?"
Nope! Loyalteez creates wallets automatically. Users just need an email address.
"Do I need to pay gas fees?"
Nope! We pay all gas fees. Your users never see or pay transaction costs.
"What programming language do I need?"
Any! If your language can make HTTP requests, it works. We have examples in JavaScript, Python, Ruby, Go, PHP, Rust, Java, and C#.
"How long does integration take?"
15-45 minutes for most platforms. We have copy-paste code examples.
"What if I get stuck?"
Email [email protected] - we'll help you!
Next Steps
Ready to integrate? Choose your platform:
- 🌐 Web App Integration
- 📱 Mobile App Integration
- 💬 Discord Bot
- 📱 Telegram Bot
- 🛒 Shopify Store
- 🎮 Game Integration
- 🔧 Custom Platform
Or learn more:
You got this! 🚀