Refriguard API Documentation

AI-Powered Core Equipment Monitoring Services for Commercial Refrigeration

Base URL: https://restroguard.com//api

🔑 Global API Token

💡 Token is saved in your browser's localStorage for convenience

Authentication

All API requests require authentication using a Bearer token.

🔐 Bearer Token Authentication

Include your API token in the Authorization header:

Authorization: Bearer YOUR_API_TOKEN

⚠️ Getting Your API Token

Go to Settings → API Tokens to generate a new token.

Device Management

GET /v1/devices

List all refrigeration devices for your workspace.

Query Parameters:
  • per_page - Items per page (default: 15)
  • status - Filter: online, offline
  • equipment_type - Filter by type
Response Example:
{
  "success": true,
  "data": {
    "devices": [
      {
        "id": 1,
        "serial": "RF-001",
        "name": "Walk-in Freezer #1",
        "equipment_type": "walkin_freezer",
        "status": "online",
        "current_temp": -18.5
      }
    ]
  }
}
🧪 Test This Endpoint
GET /v1/devices/{serial}

Get detailed information about a specific device.

🧪 Test This Endpoint
PATCH /v1/devices/{serial}/heartbeat

Update device heartbeat/status.

🧪 Test This Endpoint

Sensor Readings

POST /v1/readings

Store sensor readings from a device.

Request Body:
{
  "device_serial": "RF-001",
  "product_zone_temp": -18.5,
  "compressor_discharge_temp": 75.2,
  "compressor_suction_temp": -5.3,
  "ambient_temp": 24.0,
  "humidity": 65,
  "voltage": 220.5,
  "amp_draw": 12.3,
  "vibration_level": 2.1
}
🧪 Test This Endpoint
GET /v1/readings/latest

Get latest readings for all devices.

🧪 Test This Endpoint

Alerts & Monitoring

GET /v1/alerts

List all alerts for your workspace.

Query Parameters:
  • status - Filter: all, active, resolved
  • severity - Filter: warning, critical
🧪 Test This Endpoint
GET /v1/alerts/counts

Get alert counts by status and severity.

🧪 Test This Endpoint

Health & Analytics

GET /v1/devices/health/summary

Get overall health summary of all devices.

Response Example:
{
  "success": true,
  "data": {
    "total_devices": 5,
    "online_devices": 4,
    "health_score": 85,
    "active_alerts": 2,
    "temperature_compliance": 98.5
  }
}
🧪 Test This Endpoint

Public Policies

GET /v1/policies

Get all policy documents.

🧪 Test This Endpoint
GET /v1/policies/privacy

Get privacy policy document.

🧪 Test This Endpoint
API Documentation - Refriguard