Skip to content

Management API

Check if your service is running:

Terminal window
curl https://localhost:8443/health

Response:

{
"status": "healthy",
"uptime": "2h 15m 30s",
"version": "1.0.0"
}

Get usage statistics:

Terminal window
curl https://localhost:8443/admin/stats

Response:

{
"requests": {
"total": 1247,
"successful": 1198,
"failed": 49,
"averageResponseTime": "145ms"
},
"uptime": "2h 15m 30s",
"version": "1.0.0"
}

See recent verification requests:

Terminal window
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
}
Terminal window
# Quick health check
curl https://localhost:8443/health
# Detailed system status
curl https://localhost:8443/health/detailed
Terminal window
# Overall statistics
curl https://localhost:8443/admin/stats
# Today's statistics
curl https://localhost:8443/admin/stats?period=today
Terminal window
# Last 50 verifications
curl https://localhost:8443/admin/verifications
# Failed verifications only
curl https://localhost:8443/admin/verifications?status=failed
Terminal window
# Reset test data (development only)
curl -X POST https://localhost:8443/admin/reset-test-data
# Import fresh test cases
curl -X POST https://localhost:8443/admin/import-test-data

For easier management, visit:

  • Management endpoints require admin certificates
  • All operations are audit logged
  • Rate limited to prevent abuse

Every management operation is logged:

{
"timestamp": "2024-01-15T10:30:00Z",
"operation": "view_statistics",
"user": "admin",
"result": "success"
}
{
"error": "ACCESS_DENIED",
"message": "Admin privileges required"
}
{
"error": "SERVICE_UNAVAILABLE",
"message": "Service temporarily unavailable",
"retry_after": 30
}