Documentation

Service Integration

Service integration guide for SilverGuard AI Platform

OpenAPI 3.0.3Version 2.0.0Production Ready
Service Overview

The SilverGuard AI Platform provides comprehensive integration capabilities for aged care facilities. Features real-time incident detection, predictive analytics, automated compliance reporting, and intelligent workflows.

Base URLs

  • • Production: https://api.silverguard.ai
  • • Staging: https://staging-api.silverguard.ai
  • • Development: http://localhost:3001

Key Features

  • • Real-time incident detection and prevention
  • • Predictive analytics for proactive care
  • • Blockchain-secured audit trails
  • • Multi-facility support

Service Endpoints

Authentication
POST
/auth/login

User authentication and session management

POST
/auth/refresh

Refresh JWT tokens

POST
/auth/logout

End user session

Incidents
POST
/mcp/create_incident

Create a new incident with evidence

POST
/mcp/list_incidents

List incidents with filtering options

PUT
/incidents/{id}/status

Update incident status and response

Devices
POST
/mcp/check_device_health

Check device health and metrics

GET
/devices

List all facility devices

POST
/stream/ingest

Ingest real-time device data

Analytics
POST
/mcp/generate_kpi_report

Generate KPI and performance reports

GET
/analytics/dashboard

Real-time dashboard metrics

POST
/reporting/schedule-export

Schedule automated data exports

Data Schemas

User

User account with role-based permissions

  • id (uuid)
  • email
  • name
  • role (admin|manager|nurse|caregiver|viewer)
  • site_id
  • permissions[]
Incident

Incident detection and management

  • id (uuid)
  • type (fall_detection|wandering|medication_alert)
  • severity (minimal|low|medium|high|critical)
  • resident_id
  • location
  • status
  • evidence[]
Resident

Resident profile and care information

  • id (uuid)
  • name
  • room_number
  • risk_level
  • care_level
  • medical_conditions[]
  • emergency_contact
Device

IoT device monitoring and status

  • id
  • type (camera|motion_sensor|wearable|bed_sensor)
  • location
  • status
  • battery_level
  • last_heartbeat
Smart Services

AI-powered microservices that provide specialized operations and intelligent automation.

:8084

MCP Incident Management

AI-powered incident detection and response workflows

:8085

MCP Compliance

Automated compliance reporting and audit trail management

:8086

MCP Device Management

IoT device health monitoring and predictive maintenance

:8087

MCP Analytics

Real-time analytics and KPI generation

:8088

MCP Knowledge Base

AI-powered knowledge management and search

Security & Authentication

JWT Authentication

Bearer token authentication with refresh capabilities

BearerAuth scheme with JWT format
Service Key Authentication

Alternative authentication for service-to-service calls

X-Service-Key header authentication
Role-Based Access Control

Granular permissions based on user roles

Admin, Manager, Nurse, Caregiver, Viewer roles
Data Encryption

End-to-end encryption for sensitive data

AES-256 encryption with secure key management
Rate Limits & Performance
Standard Rate Limit1000 req/min
Burst Rate Limit100 req/sec
Response Time< 200ms
Uptime SLA99.9%
Compliance & Privacy
  • HIPAA Compliant - Healthcare data protection
  • GDPR Compliant - European data protection
  • PDPO Compliant - Hong Kong privacy ordinance
  • SOC 2 Type II - Security and availability
  • ISO 27001 - Information security management (will be obtained later)
Integration Support & Resources

Developer Support

  • • Email: support@silverguard.ai
  • • Response time: < 24 hours
  • • Technical documentation
  • • Code examples and SDKs

Resources

  • • OpenAPI 3.0.3 specification
  • • Postman collection
  • • Interactive API explorer
  • • Webhook documentation

Testing

  • • Sandbox environment
  • • Test data generators
  • • Mock API responses
  • • Integration testing tools