SOBIE Conference API Documentation

📚 SOBIE Conference API Documentation

Comprehensive guides, API references, and technical specifications for the SOBIE Conference management system backend

📁 Project Organization: For information about the project structure and file organization, see Directory Organization

� System Status & Reports

🏗️ System Architecture

🔐 Authentication & Security

Core Authentication

Advanced Authentication

👥 Administration & Management

Document	Description	Access Level
Admin API	Administrative endpoints and operations	🔒 Admin Only
Name Card API	Conference name card generation system	🔒 Admin Only
Venue API	San Destin resort booking and accommodation	🔐 Authenticated
Content Moderation	Content safety and moderation system	🔒 Admin/Moderator

🔬 Research & Academic Features

Document	Description	Access Level
Research Database	Research paper management system	🔐 Authenticated
Research Database Documentation	Detailed database schema and operations	🔐 Developer

💬 Communication & Community

Document	Description	Access Level
Communication System	Messaging and notification system	🔐 Authenticated
Bug Reporting System	GitHub-integrated bug tracking	🔓 Public

📄 Document & File Management

Document	Description	Access Level
Document Management	File upload and document handling	🔐 Authenticated

🎨 Frontend Integration Guides

JavaScript Integration Examples

Framework-Specific Guides

🔗 Quick Links

🚀 For Developers

API Base URL: http://localhost:3000/api
Health Check: http://localhost:3000/health
API Discovery: http://localhost:3000/api

📋 Common Endpoints

# Authentication
POST /api/auth/login
POST /api/auth/register
POST /api/auth/magic-link

# User Management
GET  /api/users
GET  /api/profiles/:id
PUT  /api/profiles/me

# Research
GET  /api/research
POST /api/research-submission
GET  /api/research-submission/my

# Conference
GET  /api/conference
POST /api/conference/register
GET  /api/conference/registration

# Community
GET  /api/community
POST /api/community/interest
GET  /api/community/my-interests

📱 Integration Examples

Frontend Frameworks

React Integration

// Example API call with React
const fetchUserProfile = async () => {
  const response = await fetch('/api/profiles/me', {
    headers: {
      'Authorization': `Bearer ${token}`,
      'Content-Type': 'application/json'
    }
  });
  return response.json();
};

Vue.js Integration

// Example API call with Vue.js
export default {
  async mounted() {
    try {
      const response = await this.$http.get('/api/research');
      this.papers = response.data;
    } catch (error) {
      console.error('Failed to fetch papers:', error);
    }
  }
}

Angular Integration

// Example service with Angular
@Injectable()
export class ApiService {
  constructor(private http: HttpClient) {}
  
  getConferenceInfo() {
    return this.http.get('/api/conference');
  }
}

🛠️ Development Tools

Environment Setup

# Install dependencies
npm install

# Start development server
npm run dev

# Run tests
npm test

# Validate environment
npm run validate:env

# Start production server
npm start

Testing Endpoints

# Health check
curl http://localhost:3000/health

# API discovery
curl http://localhost:3000/api

# Authentication test
curl -X POST http://localhost:3000/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"test@example.com","password":"password"}'

📊 System Status

Current Status

Server: ✅ Running on http://localhost:3000
Database: ✅ MongoDB Atlas Connected
Authentication: ✅ JWT Configured
Email Service: ✅ SMTP Configured (Development)
File Storage: ✅ Multiple Providers Supported
Logging: ✅ Winston Structured Logging

Health Monitoring

{
  "status": "OK",
  "timestamp": "2025-08-12T21:28:02.800Z",
  "uptime": 9.150,
  "database": {
    "status": "connected",
    "name": "sobienode"
  },
  "services": {
    "email": "configured",
    "sms": "not_configured"
  }
}

🔒 Security & Access Levels

Access Level Guide

🔓 Public: No authentication required
🔐 Authenticated: Valid JWT token required
🔒 Admin Only: Admin role required
🔐 Developer: Technical documentation for developers

Authentication Headers

# Required for authenticated endpoints
Authorization: Bearer <jwt_token>
Content-Type: application/json

📞 Support & Resources

Development Resources

GitHub Repository: thesobie/sobieNode
Issue Tracker: GitHub Issues
License: MIT License

API Standards

REST Principles: RESTful API design
HTTP Status Codes: Standard HTTP responses
JSON Format: Consistent JSON response structure
Error Handling: Standardized error responses

Response Format

{
  "success": true,
  "data": { /* response data */ },
  "message": "Operation completed successfully",
  "timestamp": "2025-08-12T21:28:02.800Z"
}

🗺️ Documentation Roadmap

Planned Documentation

Swagger/OpenAPI - Interactive API documentation
Postman Collection - Ready-to-use API collection
GraphQL Schema - Future GraphQL implementation
WebSocket Events - Real-time feature documentation
Database Schema - Complete data model documentation
Deployment Guide - Production deployment instructions

🎯 Best Practices

API Usage

Always authenticate for protected endpoints
Handle errors gracefully with proper status codes
Use pagination for large data sets
Implement caching for frequently accessed data
Follow rate limits to avoid throttling

Security Guidelines

Store JWT tokens securely (httpOnly cookies recommended)
Validate all inputs on the frontend
Use HTTPS in production
Implement CSRF protection for web applications
Regular security audits of dependencies

Last Updated: August 12, 2025
Documentation Version: 1.0.0
Backend Version: 1.0.0

**🚀 Ready to build amazing applications with the SOBIE Conference API! 🚀** *For questions or support, please create an issue in the GitHub repository.*