Skip to main content

Backend REST API Overview

The ID PASS DataCollect Backend provides a comprehensive REST API automatically documented from the OpenAPI 3.0 specification.

🔄 Auto-Generated Documentation​

The API documentation below is automatically generated from the backend's openapi.yaml specification file. This ensures:

  • Always Up-to-Date: Documentation reflects the current implementation
  • Consistent: No manual synchronization needed
  • Interactive: Test endpoints directly from the documentation
  • Complete: All endpoints, schemas, and examples included

📚 API Documentation Structure​

The generated documentation is organized by API tags:

  • Authentication - User login and token management
  • User Management - CRUD operations for users (Admin only)
  • Synchronization - Data sync between clients and server
  • App Configuration - Multi-tenant configuration management
  • Data Management - Entity management and duplicate resolution

🌐 Interactive Testing​

For live API testing with Swagger UI, start the backend server and visit:

http://localhost:3000/api-docs

🔧 Authentication​

Most endpoints require JWT authentication. Include the token in requests:

Authorization: Bearer <your-jwt-token>

Getting a Token​

curl -X POST http://localhost:3000/api/users/login \
  -H "Content-Type: application/json" \
  -d '{"email": "admin@hdm.example", "password": "your-password"}'

📖 OpenAPI Specification​

The complete specification is available at: