S.A.F.E. SMART
API Documentation

S.A.F.E. SMART Integration API

Connect your security systems, sensors, and software to publish real-time alerts, drill data, and performance benchmarks directly to school dashboards.

Getting Started

1. Get API Key

School administrators generate API keys from their dashboard with specific permissions.

2. Integrate

Use our REST API to send data from your system. Simple JSON over HTTPS.

3. Go Live

Data appears instantly on school dashboards. Monitor usage and logs in real-time.

Authentication

All API requests require authentication using an API key in the request header:

x-api-key: YOUR_API_KEY

API Endpoints

POST
/api/receiveAlert
Publish Alert

Publish real-time alerts, threats, or incidents to school dashboards

Requires: alerts permission

Request Body

alert_type
string
required
threat, incident, drill...
severity
string
low, medium, high...
title
string
required
description
string
metadata
object
curl -X POST https://safesmart.world/api/receiveAlert \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "alert_type": "threat",
    "severity": "high",
    "title": "Unauthorized Entry Detected",
    "description": "Motion detected at east entrance",
    "metadata": {
      "camera_id": "CAM-101",
      "location": "Building A - East Door"
    }
  }'
POST
/api/receiveDrill
Log Drill

Automatically log drill records with response times and participant data

Requires: drills permission

Request Body

drill_type
string
required
lockdown, evacuation, shelter...
drill_date
string
required
start_time
string
response_time_seconds
number
participants_count
number
issues_identified
string
improvements_noted
string
was_announced
boolean
curl -X POST https://safesmart.world/api/receiveDrill \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "drill_type": "lockdown",
    "drill_date": "2026-02-04",
    "start_time": "10:30 AM",
    "response_time_seconds": 45,
    "participants_count": 450,
    "was_announced": false
  }'
POST
/api/receiveBenchmark
Submit Benchmark

Track performance metrics, compliance scores, and readiness assessments

Requires: benchmarks permission

Request Body

benchmark_type
string
required
response_time, completion_rate, compliance...
metric_name
string
required
metric_value
number
required
metric_unit
string
target_value
number
assessment_date
string
notes
string
curl -X POST https://safesmart.world/api/receiveBenchmark \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "benchmark_type": "response_time",
    "metric_name": "Average Lockdown Response",
    "metric_value": 38.5,
    "metric_unit": "seconds",
    "target_value": 30,
    "assessment_date": "2026-02-04"
  }'

Error Codes

401

Unauthorized

Missing or invalid API key

403

Forbidden

API key doesn't have required permission

400

Bad Request

Missing required fields or invalid data format

500

Internal Server Error

Something went wrong on our end

Common Use Cases

Security Systems

Integrate visitor management, access control, and surveillance systems to automatically alert schools of unauthorized access or threats.

Raptor, Verkada, SAFR

Emergency Systems

Connect panic buttons, mass notification platforms, and emergency alert systems to publish real-time incidents to dashboards.

CrisisGo, Rave, AlertMedia

Ready to Integrate?

Contact us to discuss your integration needs and get started with the S.A.F.E. SMART API.