An open API service indexing awesome lists of open source software.

https://github.com/ricardohuaripata/linkplaza-api

A RESTful API for a link management platform, allowing users to centralize and customize their web and social media links. Built using Spring Boot, Spring Data JPA with MySQL and Spring Security with JWT Authentication.
https://github.com/ricardohuaripata/linkplaza-api

cloudinary java jwt link-in-bio linktree linktree-clone rest-api spring-boot spring-security

Last synced: about 2 months ago
JSON representation

A RESTful API for a link management platform, allowing users to centralize and customize their web and social media links. Built using Spring Boot, Spring Data JPA with MySQL and Spring Security with JWT Authentication.

Awesome Lists containing this project

README

        





linkplaza logo

LinkPlaza API



A RESTful API for a link management platform, allowing users to centralize and customize their web and social media links. Built using Spring Boot, Spring Data JPA with MySQL and Spring Security with JWT Authentication.

Frontend repository


Postman API documentation


linkplaza thumbnail

## Endpoints

* **Auth Controller**
* POST /api/v1/auth/signup - User sign up.
* POST /api/v1/auth/signin - User sign in.
* POST /api/v1/auth/forgot-password - Request password reset.
* POST /api/v1/auth/reset-password - Reset password.
* **User Controller**
* GET /api/v1/user/{id} - Get user by ID.
* GET /api/v1/user/account/info - Get account information.
* PATCH /api/v1/user/account/email - Change email.
* PATCH /api/v1/user/account/password - Change password.
* POST /api/v1/user/account/signout - Sign out.
* POST /api/v1/user/account/verify - Verify account.
* DELETE /api/v1/user/account - Delete account.
* POST /api/v1/user/account/send-account-verification-code - Send verification code to verify email.
* POST /api/v1/user/account/send-delete-account-verification-code - Send verification code to delete account.
* **Page Controller**
* GET /api/v1/page/{url} - Get page by URL.
* POST /api/v1/page - Create a new page.
* PATCH /api/v1/page/{id} - Update page.
* PATCH /api/v1/page/{id}/picture - Upload page picture.
* DELETE /api/v1/page/{id} - Delete page.
* POST /api/v1/page/{id}/social-link - Add social link.
* PUT /api/v1/page/{id}/social-link/sort - Sort social links.
* PATCH /api/v1/page/social-link/{id} - Update social link.
* DELETE /api/v1/page/social-link/{id} - Delete social link.
* POST /api/v1/page/{id}/custom-link - Add custom link.
* PUT /api/v1/page/{id}/custom-link/sort - Sort custom links.
* PATCH /api/v1/page/custom-link/{id} - Update custom link.
* DELETE /api/v1/page/custom-link/{id} - Delete custom link.
* **Analytic Controller**
* POST /api/v1/analytic/visit - Log a page visit.
* POST /api/v1/analytic/social-link-click - Log a social link click.
* POST /api/v1/analytic/custom-link-click - Log a custom link click.
* GET /api/v1/analytic - Get page analytics by date range.

## Database Diagram
![linkplaza-db](https://github.com/user-attachments/assets/f916eb61-a129-4ee2-87fd-7cbfd784fe91)