תיעוד ה-API

התחלה מהירה

את ה-API key קיבלת מספק השירות. שלח אותו ב-header בשם X-API-Key:

curl -H "X-API-Key: YOUR_API_KEY" \
  {{BASE}}/v1/traffic

const res = await fetch("{{BASE}}/v1/traffic", {
  headers: { "X-API-Key": "YOUR_API_KEY" },
});
const data = await res.json();
console.log(data.current.downloadMbps);

import requests

r = requests.get(
    "{{BASE}}/v1/traffic",
    headers={"X-API-Key": "YOUR_API_KEY"},
    timeout=15,
)
print(r.json()["current"])

התשובה:

{
  "status": "Active",
  "current": { "downloadMbps": 125.4, "uploadMbps": 32.8 },
  "month":   { "from": "2026-10-01T00:00:00.000Z", "downloadGB": 842.5, "uploadGB": 216.3 },
  "updatedAt": "2026-10-12T12:23:29.145Z"
}

אימות

כל בקשה צריכה לכלול את המפתח באחת משתי הדרכים:

X-API-Key: YOUR_API_KEY
Authorization: Bearer YOUR_API_KEY

GET /v1/traffic

סיכום התעבורה שלך: הקצב כרגע והנפח מתחילת החודש. זה ה-endpoint הנפוץ ביותר, והוא מתאים להצגה ישירה בדשבורד.

שדות התשובה

GET /v1/sensors

רשימת הסנסורים שמוקצים לך.

{ "sensors": [ { "id": 1234, "alias": "main-link" } ] }

אפשר להשתמש ב-id או ב-alias בכתובות הבאות.

GET /v1/sensors/:idOrAlias

המצב הנוכחי של סנסור אחד, כולל כל ה-Channels שלו.

{
  "id": 1234,
  "alias": "main-link",
  "status": "Up",
  "message": "OK",
  "lastCheck": "10/12/2026 3:23:00 PM [30 s ago]",
  "channels": [
    { "name": "Download", "display": "1.2 Mbit/s", "value": 150000.5 },
    { "name": "Upload",   "display": "0.3 Mbit/s", "value": 37500.2 }
  ]
}

display הוא הערך כפי שמוצג למשתמש, ו-value הוא הערך הגולמי לעיבוד (בדרך כלל בתים לשנייה).

GET /v1/sensors/:idOrAlias/history

היסטוריית תעבורה לטווח זמן, מחולקת לפרקי זמן שווים.

הטווח המרבי הוא 40 יום.

curl -H "X-API-Key: YOUR_API_KEY" \
  "{{BASE}}/v1/sensors/main-link/history?from=2026-10-11T00:00:00Z&interval=3600"

{
  "id": 1234,
  "alias": "main-link",
  "interval": 3600,
  "data": [
    {
      "time": "10/12/2026 1:00:00 PM - 2:00:00 PM",
      "Download (Speed)": 150000.5,
      "Download (Volume)": 540001800,
      "Upload (Speed)": 37500.2,
      "Upload (Volume)": 135000720,
      "coverage": 100
    }
  ]
}

GET /v1/metrics

מדדי השרת שלך, למשל צריכת חשמל, זרם, טמפרטורה וזמן פעילות. כל מדד הוא ערך אחד עם יחידה וסטטוס.

{
  "metrics": [
    { "server": "server1", "name": "power",   "label": "צריכת חשמל", "value": 216,  "unit": "W", "limit": null, "overLimit": false, "status": "Up" },
    { "server": "server1", "name": "current", "label": "זרם",        "value": 1.42, "unit": "A", "limit": 1.3,  "overLimit": true,  "status": "Warning" },
    { "server": "server1", "name": "online",  "label": "זמינות",     "value": null, "unit": "",  "limit": null, "overLimit": false, "status": "Up" }
  ],
  "updatedAt": "2026-10-12T12:23:29.145Z"
}

GET /v1/metrics/history

היסטוריה של מדד אחד, למשל צריכת חשמל (W) או זרם (A), מחולקת לפרקי זמן שווים.

curl -H "X-API-Key: YOUR_API_KEY" \
  "{{BASE}}/v1/metrics/history?server=server1&name=current&from=2026-10-11T00:00:00Z&interval=3600"

{
  "server": "server1",
  "name": "current",
  "label": "זרם",
  "unit": "A",
  "limit": 1.3,
  "interval": 3600,
  "summary": { "min": 0.93, "max": 1.41, "avg": 1.02 },
  "data": [
    { "time": "2026-10-11T07:00:00.000Z", "value": 0.94, "coverage": 100 },
    { "time": "2026-10-11T08:00:00.000Z", "value": 1.41, "coverage": 100 }
  ]
}

GET /v1/servers

אם יש לך כמה שרתים, זה מראה אילו קיימים ואילו מדדים יש לכל אחד. אחר כך בוחרים שרת עם /v1/metrics?server=….

{
  "servers": [
    { "server": "server1", "label": "Server 1", "metrics": ["power", "current", "online"] },
    { "server": "server2", "label": "Server 2", "metrics": ["power", "current"] }
  ]
}

curl -H "X-API-Key: YOUR_API_KEY" \
  "{{BASE}}/v1/metrics?server=server2"

שרת שלא קיים מחזיר 404 עם server_not_found.

שגיאות

שגיאה מחזירה קוד HTTP מתאים וגוף JSON בצורה { "error": "קוד" }.

מגבלות והערות

• קצב בקשות: עד 60 בקשות בדקה לכל מפתח.
• רענון נתונים: הנתונים מתעדכנים בערך כל דקה. התשובות נשמרות עד 30 שניות, והנפח החודשי עד 5 דקות, ולכן אין טעם לשאול לעתים קרובות יותר.
• נפח חודשי: מחושב מהיסטוריית הניטור בממוצעי שעה, ולכן הוא מדויק בקירוב ולא לחיוב ברמת הבייט.
• יחידות: Mbps הוא מגהביט (10⁶ ביטים) לשנייה, ו-GB הוא 10⁹ בתים.
• שעות: שעות ב-history הן שעון ישראל.
• אבטחה: הגישה היא ב-HTTPS בלבד.

נסה עכשיו

הדבק את המפתח שלך, בחר endpoint ומלא פרמטרים, ולחץ כדי לראות תשובה אמיתית. אחרי הזנת המפתח השדות יציעו את הסנסורים, השרתים והמדדים שלך. המפתח נשלח רק לשרת הזה ולא נשמר בדפדפן.