Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nortex-dev/licensingapi
Create, manage and validate licenses for any project. This self-hostable web API allows you to generate license keys, store them and validate them later to confirm the authority of your project. Uses any SQL database. Written fully in TypeScript.
https://github.com/nortex-dev/licensingapi
Last synced: 24 days ago
JSON representation
Create, manage and validate licenses for any project. This self-hostable web API allows you to generate license keys, store them and validate them later to confirm the authority of your project. Uses any SQL database. Written fully in TypeScript.
- Host: GitHub
- URL: https://github.com/nortex-dev/licensingapi
- Owner: NorteX-dev
- Created: 2022-10-22T19:56:22.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-11-12T17:46:54.000Z (over 1 year ago)
- Last Synced: 2024-11-19T21:40:17.484Z (3 months ago)
- Language: TypeScript
- Size: 111 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Licensing API
### Version 1.0
----
## Main features:
- generate unique license keys
- intuative REST API to create, edit, delete and validate licenses
- define own API keys that allow admin control over the application
- easily validate existing keys
- set expiration times on licenses
- add labels on licenses for easy identification
- soon: graphical user interface to manage licenses
This API was made with the intention to use in 3rd party applications, like desktop software or websites.
## Routes documentation:
| Method | Route | Description | Query Parameters | Body | Requires Authentication? (refer to [Authentication](#authentication)) |
|--------|------------------------------|--------------------------------------------------------|------------------|---------------------------------------|-----------------------------------------------------------------------|
| GET | / | Index route, displays version | none | | |
| GET | /licenses/validate/:key | Validate a license key | key: string | | |
| GET | /licenses/validate/:key/info | Validate a license key and return extended information | key: string | | ✅ |
| GET | /licenses | Get all licenses | none | | ✅ |
| GET | /licenses/:id | Get license by id | id: string | | ✅ |
| POST | /licenses | Create new license | none | `{ label: string, exp?: timestamp }` | ✅ |
| PATCH | /licenses/:id | Fully edit by id | id: string | `{ label: string, exp: timestamp }` | ✅ |
| PUT | /licenses/:id | Partially edit by id | id: string | `{ label?: string, exp?: timestamp }` | ✅ |
## Authentication
To authenticate, you need to send a header with the key `X-API-KEY` and the value of your API key.
You can configure mutliple api keys in the `config.ts` file (`src/util/config.ts`).