KeyRack: A portal for disbursing IDE etc license key codes to Scaler learners

[championswimmer]

Summary

At Scaler we distribute license keys for IDEs like Jetbrains/Visual Studio sometimes (when we get them for students). The process of manually reverting over email to individual learners and copy pasting license keys one by one is tedious and we have to manually keep track of which keys have been distributed and used.

KeyRack will be a small portal where we can bulk upload license keys (usually we receive them in form a txt file with one license key per line), and then learners can chose to apply for license for certain products. The instructors can approve the request and then the learner will be send the license key. A license key once given to someone is marked as "distributed" so it is not re-shared with anyone else.

Features

Entities (Product level)

Products

Defines what product the key is for. Could be something like Jetbrains IntelliJ IDEA (an IDE), or could be AWS (a service) etc.

Keys

Defines a license key. The key itself would be a string (usually coupon code for services, or a the key of a software itself is a string).

• It should be apparent which product the key is of
• It should have validity information (from when to when it can be used)
• It should have status information (used, new)

Users

People using this project - will be of 2 types

• learners who will request for license keys
• admins (Scaler team members) who have the authority to disburse license keys to people

[championswimmer]

Tech Specs

Database Schema Design

Base Table

All tables have these (basically in our ORM, all entities will extend from this entity)

• id: integer auto increment
• createdAt
• updatedAt

Products

• name: string
• type: enum (software, service, ...)
• description: text
• link: string (url) - link to the product website (eg: https://jetbrains.com/intellijidea)

Keys

• data: string
• useDateStart: date
• useDateEnd: date
• validDateStart: date
• validDateEnd: date
• validityDays: long
• status: enum (new, used, expired)

Example: A key which can be activated between 1st Nov 2021 and 31st Dec 2021. It has a validity of 1 year. It will not be valid after 2022. useDateStart: 1 Nov 2021; useDateEnd: 31 Dec 2021; validDateStart: 1 Nov 2021; validDateEnd: 31 Dec 2022; validityDays: 365

ProductKey

(mapping table to define which keys can be used for which products)

• productId
• keyId

Users

• username: string unique
• email: string unique
• password: string (save hashed password only)
• role: enum (learner, admin...)

Request

• userId - the user who requested it
• status: enum (new, approved, denied, cancelled)
• productId - the product for which key is needed
• approverId - the user (must be admin role) who approved the request
• keyId - the key that was allocate to the user

[championswimmer]

API Design

Legend
🔐	Needs authentication
👮	Only admin
📄	Paginated
🧑	only to user who created it

Users

POST /users

Register new user

POST /users/login

Login user

Products

GET /products 🔐 📄

See all products

GET /products/{id} 🔐

Get a particular product
Should also show how many available keys for this product are there

POST /products 🔐 👮

Add a product

PATCH /products/{id} 🔐 👮

Update desc, link etc of a product

Keys

GET /keys 🔐 👮 📄

Show all keys

GET /keys/{id} 🔐 👮

Get details of a particular key

POST /keys 🔐 👮

Add a new license key

PATCH /keys 🔐 👮

Add keys in bulk

PATCH /keys/{id} 🔐 👮

To update validity info, or state of a key

Requests

POST /requests 🔐

Create a new request to get a license key

GET /requests 🔐 👮 📄

Show all requests
Allow filtering by new requests ?status=new, or requests for a particular product as well ?products=2,6,7

GET /requests/{id} 🔐 🧑 👮

Show a particular request

PATCH /requests/{id} 🔐 🧑 👮

Update status of request

• user themselves might cancel a request
• admins can approve and allocate a key to that request

PUT /requests/{id}/approve 🔐 👮

Direct request approval endpoint. Allocates the next available key for this product and immediately approves the request.
Should send a non 201 response (maybe 404 because key not found), if new keys for this product are not anymore available.

PATCH /requests 🔐 👮

Body

[
  {id: <req id 1>, status: approved },
  {id: <req id 2>, status: approved },
  {id: <req id 3>, status: approved }
]