Logo
  • داشبورد
  • بلیط‌ها
  • کلیدهای API
  • API توسعه‌دهندگان
  • نقشه ماهواره‌ها
  • کیف پول
  • صفحه شخصی
Logo

API توسعه‌دهندگان

با کلید API خود، از هر زبان یا سرویسی به داده‌های مودم‌هایتان دسترسی داشته باشید.

احراز هویت

  1. از بخش کلیدهای API یک کلید بسازید (فقط یک‌بار نمایش داده می‌شود).
  2. کلید را در هر درخواست، در هدر X-API-Key قرار دهید (یا به‌صورت Authorization: Bearer hdp_…).
X-API-Key: hdp_xxxxxxxxxxxxxxxx

آدرس پایه

https://gateway.nobicode.ir/iot/api/v1/hodhod

همهٔ پاسخ‌ها JSON و به‌صورت { "success": true, "data": … } هستند. داده‌ها فقط برای مودم‌هایی است که به شما تخصیص داده شده‌اند.

لیست مودم‌ها (ترمینال‌ها)

GEThttps://gateway.nobicode.ir/iot/api/v1/hodhod/my-terminals

فهرست مودم‌هایی که به حساب شما تخصیص داده شده‌اند، همراه با تعداد پیام و آخرین زمان ارسال.

نمونه درخواست

curl "https://gateway.nobicode.ir/iot/api/v1/hodhod/my-terminals" \
  -H "X-API-Key: hdp_xxxxxxxxxxxxxxxx"

نمونه پاسخ

{
  "success": true,
  "data": [
    {
      "terminal_id": "17577",
      "name": null,
      "message_count": 7,
      "first_seen_at": "2026-10-06T12:36:28+00:00",
      "last_message_at": "2026-10-06T12:40:08+00:00"
    }
  ]
}

پکت‌های یک مودم

GEThttps://gateway.nobicode.ir/iot/api/v1/hodhod/terminals/{terminal_id}/messages

دریافت پکت‌های (پیام‌های) ارسالی یک مودم مشخص، به‌صورت صفحه‌بندی‌شده. با پارامتر q می‌توانید در محتوا جستجو کنید.

نمونه درخواست

curl "https://gateway.nobicode.ir/iot/api/v1/hodhod/terminals/17577/messages?page=1&page_size=20" \
  -H "X-API-Key: hdp_xxxxxxxxxxxxxxxx"

نمونه پاسخ

{
  "success": true,
  "data": [
    {
      "id": 10,
      "terminal_id": "17577",
      "satellite_name": "8873915124...",
      "content": "Test Hi10",
      "raw_content": "546573742048693130",
      "frame_crc": 0,
      "message_time": "2026-10-06T12:40:08+00:00"
    }
  ],
  "pagination": { "page": 1, "page_size": 20, "total": 7, "total_pages": 1 }
}

آمار

GEThttps://gateway.nobicode.ir/iot/api/v1/hodhod/stats?period=30d

آمار کلی پیام‌های شما در یک بازهٔ زمانی (۷d، ۳۰d، ۹۰d یا all).

نمونه درخواست

curl "https://gateway.nobicode.ir/iot/api/v1/hodhod/stats?period=30d" \
  -H "X-API-Key: hdp_xxxxxxxxxxxxxxxx"

نمونه پاسخ

{
  "success": true,
  "data": {
    "total_messages": 16,
    "today_messages": 16,
    "active_terminals": 2,
    "total_terminals": 2,
    "crc_pass_rate": 100.0
  }
}

نکته: زمان‌ها به‌صورت UTC برگردانده می‌شوند (ISO‑8601) و کلاینت آن‌ها را به زمان محلی تبدیل می‌کند.