Management API
Health Check
Section titled “Health Check”Check if your service is running:
curl https://localhost:8443/health
Response:
{ "status": "healthy", "uptime": "2h 15m 30s", "version": "1.0.0"}
Service Statistics
Section titled “Service Statistics”Get usage statistics:
curl https://localhost:8443/admin/stats
Response:
{ "requests": { "total": 1247, "successful": 1198, "failed": 49, "averageResponseTime": "145ms" }, "uptime": "2h 15m 30s", "version": "1.0.0"}
Recent Verifications
Section titled “Recent Verifications”See recent verification requests:
curl https://localhost:8443/admin/verifications?limit=10
Response:
{ "verifications": [ { "id": "ver-123456789", "name": "John Smith", "iban": "DE89370400440532013000", "result": "MATCH", "timestamp": "2024-01-15T10:30:00Z" } ], "total": 1247}
Common Management Tasks
Section titled “Common Management Tasks”🔍 Monitor Service Health
Section titled “🔍 Monitor Service Health”# Quick health checkcurl https://localhost:8443/health
# Detailed system statuscurl https://localhost:8443/health/detailed
📊 View Usage Statistics
Section titled “📊 View Usage Statistics”# Overall statisticscurl https://localhost:8443/admin/stats
# Today's statisticscurl https://localhost:8443/admin/stats?period=today
📋 Review Recent Activity
Section titled “📋 Review Recent Activity”# Last 50 verificationscurl https://localhost:8443/admin/verifications
# Failed verifications onlycurl https://localhost:8443/admin/verifications?status=failed
🔧 Administrative Tasks
Section titled “🔧 Administrative Tasks”# Reset test data (development only)curl -X POST https://localhost:8443/admin/reset-test-data
# Import fresh test casescurl -X POST https://localhost:8443/admin/import-test-data
Web Interface
Section titled “Web Interface”For easier management, visit:
- 📊 Dashboard: https://localhost:8443/admin
- 📈 Statistics: https://localhost:8443/admin/stats
- 🧪 Test Interface: https://localhost:8443/test
Security
Section titled “Security”🔒 Access Control
Section titled “🔒 Access Control”- Management endpoints require admin certificates
- All operations are audit logged
- Rate limited to prevent abuse
📝 Audit Trail
Section titled “📝 Audit Trail”Every management operation is logged:
{ "timestamp": "2024-01-15T10:30:00Z", "operation": "view_statistics", "user": "admin", "result": "success"}
Error Responses
Section titled “Error Responses”Access Denied
Section titled “Access Denied”{ "error": "ACCESS_DENIED", "message": "Admin privileges required"}
Service Unavailable
Section titled “Service Unavailable”{ "error": "SERVICE_UNAVAILABLE", "message": "Service temporarily unavailable", "retry_after": 30}