ForestLink API Documentation

ForestLink is a comprehensive system for forest management and monitoring that provides REST API endpoints for interacting with forest data.

The ForestLink backend provides:

  • RESTful API endpoints for data access and manipulation
  • MQTT listener service for ForestLink IoT devices deployed in forests
  • Data aggregation and collection from forest monitoring sensors
  • Structured API endpoints for consumption by the Angular client application

Key Components

  • Authentication: JWT-based authentication for API access and form-based authentication for web panel
  • User Management: Role-based access control with different permission levels
  • Data Models: Comprehensive domain models for forest monitoring and management
  • REST APIs: RESTful endpoints for programmatic access to the system
  • MQTT Integration: Listeners for IoT device data collection from forest sensors
  • Data Aggregation: Services for processing and analyzing collected forest data

Package Structure

fr.isen.forestlink
Main package containing application entry point and core functionality
fr.isen.forestlink.config
Security configuration, JWT filter, and application configuration
fr.isen.forestlink.controller
REST API controllers and endpoints
fr.isen.forestlink.handler.Exception
Global exception handling for API requests
fr.isen.forestlink.model
Data models and entities for forest management
fr.isen.forestlink.model.dto
Data Transfer Objects for API communication
fr.isen.forestlink.model.user
User-related models including roles and permissions
fr.isen.forestlink.repository
Data access layer and database repositories
fr.isen.forestlink.request
Request objects for API input validation
fr.isen.forestlink.response
Response objects for consistent API output formatting
fr.isen.forestlink.service
Business logic services including JWT handling and user management