Yayy Platform API

Digital rewards and discount platform API for connecting users with exclusive deals from merchants

Download Postman Collections

API Overview

Comprehensive RESTful API for managing users, merchants, products, discounts, and points

User Management

Complete authentication and user management system with JWT tokens, OAuth support, and point balance tracking.

Merchant APIs

Merchants can manage their products, discounts, and track performance through dedicated endpoints.

Product & Discounts

Browse products, featured deals, and discounts. Get recommendations and search by category, location, and more.

Points System

Integrated points system for users with transaction history, balance tracking, and currency conversion.

Secure Authentication

JWT-based authentication with support for Google, Facebook OAuth, and role-based access control.

Admin Panel

Admin endpoints for managing categories, point sources, and user points with full administrative control.

API Documentation

Get started quickly with our Postman collections

Postman Collection

Complete API collection for testing

Available Collections:
Auth Routes Collection

Authentication endpoints for users and merchants
Merchant Products, Discounts & Categories Collection

Product management, discount management, and category endpoints for merchants and admins
User Routes Collection

Complete user endpoints including authentication, profile, points, yayy card, transactions, and products
Admin Routes Collection

Complete admin endpoints for managing users, merchants, points, categories, rewards, point sources, yayy cards, and configs
Import Instructions: Download the Postman collection JSON file and import it into Postman to get started with API testing.

API Endpoints

Explore the available API endpoints

User Endpoints
  • POST /api/user/auth/register
  • POST /api/user/auth/login
  • POST /api/user/auth/google
  • POST /api/user/auth/facebook
  • GET /api/user/points
Merchant Endpoints
  • POST /api/merchant/auth/register
  • POST /api/merchant/auth/login
  • GET /api/merchant/products
  • POST /api/merchant/products
  • GET /api/merchant/discounts
  • POST /api/merchant/discounts
Product Endpoints
  • GET /api/products
  • GET /api/products/:uuid
  • GET /api/products/featured
  • GET /api/products/recommended/:productUuid
Admin Endpoints
  • POST /admin/auth/login
  • POST /admin/api/points/add
  • POST /admin/api/points/subtract
  • GET /admin/api/points/user/:userUuid

Quick Start

Getting Started
  1. Download the Postman collections from the Documentation section above
  2. Import the collections into Postman
  3. Set up your environment variables (base URL, API keys)
  4. Start testing the API endpoints