Welcome
The Portal Self-Service Backend API is a comprehensive REST API built with Express.js that powers employee self-service portals. It provides secure authentication via Microsoft Entra ID (Azure AD), a sophisticated request approval workflow, and real-time notifications through WebSockets.Quickstart
Get up and running with the API in minutes
Architecture
Understand the system design and components
API Reference
Explore all available endpoints
Azure AD Setup
Configure Microsoft Entra ID authentication
Key Features
Azure AD Authentication
Secure JWT-based authentication with Microsoft Entra ID (Azure AD)
Request Workflow
Approval system for vacations, profile updates, and custom requests
Real-time Notifications
Socket.io WebSocket integration for instant updates
Role-Based Access
Three-tier permission system: Employee, Admin, Super Admin
File Management
Upload and manage documents with Multer
Admin Dashboard
Vacation statistics and workforce analytics
Core Capabilities
Employee Management
Manage employee profiles, search the directory, and handle profile update requests with proper authorization controls.Request System
Create, approve, and track employee requests including vacation time, profile changes, and custom request types with a complete audit trail.Communication
Broadcast announcements to employees, manage FAQ content, and send real-time notifications through WebSockets.Integrations
- Database: MSSQL with Sequelize ORM
- Authentication: Microsoft Entra ID (Azure AD) with JWT
- Real-time: Socket.io for WebSocket connections
- Documentation: OpenAPI/Swagger integration
Get Started
Follow the Quickstart Guide
Set up your environment, configure Azure AD, and make your first API call in under 10 minutes