@mojito-inc/loyalty-sdk v1.0.1

Mojito Loyalty Core SDK

Welcome to the Mojito Loyalty Platform SDK — your all-in-one developer toolkit to integrate powerful loyalty mechanics directly into your Web App and Node.js API.

This SDK is your gateway to building engaging user experiences with missions, rewards, and real-time point systems — all while seamlessly interacting with Mojito’s platform APIs.

• 🔗 https://getmojito.com/loyalty
• 📚 Docs: https://loyaltydocs.getmojito.com/
• 📧 Support: dev-support@mojito.xyz

✨ Features

• 🔐 User authentication
• 🏆 Retrieve leaderboard data
• 🎯 Access missions and rewards
• 🧾 Claim missions to earn points
• 🎁 Redeem and distribute rewards

🔑 Getting Access

To use the SDK, generate your API Key by logging into the Mojito Admin Portal.
Go to the API section and generate your api key — you'll need it for all SDK calls.

📦 Installation

Install via npm:

npm install @mojito-inc/loyalty

Or via yarn:

yarn add @mojito-inc/loyalty

🚀 Usage

🔐 Authentication

Set API Key

const sdk = new LoyaltyClient('prod');
sdk.auth.setApiKey('your-api-key-here');

Fetch the sign Message for Web3 Wallet

const sdk = new LoyaltyClient('prod');
sdk.auth.fetchSignMessage('wallet-address', sdk.auth);

Generate JWT from Web3 Wallet

const sdk = new LoyaltyClient('prod');
sdk.auth.generateJWT('wallet-address', 'signature', 'chain', 'message', sdk.auth);

Use Existing JWT Token

const sdk = new LoyaltyClient('prod');
sdk.auth.setJWT('your-jwt-token');

🧾 Claims Management

Initiate a Claim

let response = await sdk.claim.initiateClaim('mission-id', 'user-unique-address', sdk.auth);

Fetch Claim Status

let response = await sdk.admin.getClaimStatus('tenant-slug', 'mission-id', 'user-unique-address', 'claim-id', sdk.auth);

🎁 Reward Redemption

Initiate a Redeem

let response = await sdk.redeemption.initiateReward('reward-id', 'user-unique-address', 'wallet-address', sdk.auth);

📌 Missions and Rewards

Fetch Mission by ID

let response = await sdk.admin.getMissions('mission-id', sdk.auth);

Fetch Reward by ID

let response = await sdk.admin.getRewards('reward-id', sdk.auth);

📞 Contact & Support

• 📚 Docs: https://loyaltydocs.getmojito.com/
• 📧 Email: dev-support@mojito.xyz