Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 3.54 KB

README.md

File metadata and controls

50 lines (33 loc) · 3.54 KB
Raw

SneaksHub Ecommerce-REST API

Welcome to SneaksHub API documentation. This API can serve as the backend for your sneakers/footwares E-commerce platform, Allowing users to register, signIn, create and manage products for Intending customers. Whether you're a developer integrating our API into your application or a curious user wanting to understand the technical aspects, this readme will guide you through the process.

Introduction

This API will provide the basic tools for sneakers/footwares E-commerce platform to manage, create and interact with intending buyers, sellers and their various products in an efficient manner. Allowing sellers to create and manage their different produtcs, and buyers to view and purchase these products seamlessly. This API aims to simplify the E-commerce experience for its various users.

Key Features

  • Virtual Accounts/Wallets - Every Authenticated user would have a unique wallet in which they can fund and use to make payments for purchases made. if a user purchases an item the price of the item will be deducted from his wallet balance automatically. Sellers can also receive payments via their wallet for any products sold, once a buyer purchases a product the price of that product would be deducted from the buyers wallet and credited to the sellers wallet. Sellers can easily withdraw their earnings from the wallets directly to their bank account.
  • Payments - There would be a payment system that allows users to fund their virtual accounts/ wallets, The funded amount will be displayed in the users wallet after the payment has been confirmed. They can purchase any product of their choice and pay with the funded wallets ( As long as the amount in their wallet is enough to cover the price of the item they wish to purchase).
  • Receipts Generator - After every purchase a downloadable receipt would be generated containing all the details of the purchased item.
  • Image Uploads (with multer) - Sellers can upload images if their products.
  • JWT Authentication - Registered users will be authenticated using jwt before they can be granted access to their accounts.
  • Pagination
  • Memory caching (Using redis)
  • Email Sending - Emails will be sent out at different stages in this application using the mailgun API.
    • email confirmation - after registration a confirmation email with a unique link will be sent to the email provided during registration. The user is required to click the unique link to confirm their email.
    • Welcome message - A welcome message will be sent out to users after they successfully confrim their email.
    • Payments - An email will be sent upon successfull funding of wallets
    • Successfully Purchased - An email containng the details of the transactions and recipts will be sent to a buyer after every purchase.
    • Successfull sale - An email will be sent to a seller upon making a succesfull sale.

Getting Started

To start using the SneaksHub E-commerce API, follow these steps:

  1. Sign Up: Create an account on our platform to obtain API credentials.
  2. Authentication: Acquire a token to authenticate your requests.
  3. Explore Endpoints: Review the available API endpoints and their functionalities.
  4. Make Requests: Make HTTP requests to interact with the API and create/manage crowdfunding campaigns.
  5. Handle Responses: Process the API responses according to your application's requirements.

Authentication

To authenticate your requests, include your token in the headers of your HTTP requests: