noc724 REST API.

noc724 یه API ساده داره. باهاش می‌تونید جزئیات و آپتایم مانیتورهاتون رو بگیرید، مانیتور، صفحه‌ی وضعیت، بازه‌ی نگهداری و کانال هشدار بسازید، ویرایش و حذف کنید، و حادثه‌ها رو دنبال کنید.

قالب پاسخ

API داده‌ها رو با قالب JSON برمی‌گردونه. زمان‌ها به وقت UTC و با قالب ISO 8601 هستن.

محدودیت تعداد درخواست

برای جلوگیری از استفاده‌ی بی‌رویه، درخواست‌هایی که کار سنگین انجام می‌دن محدودیت دقیقه‌ای دارن:

Create a monitor : 30 req/min
Check a monitor now : 20 req/min
Send a test alert : 10 req/min
Send a heartbeat : 120 req/min ( per IP address )

وقتی به محدودیت برسید، API کد وضعیت 429 برمی‌گردونه، همراه با این هدرها:

X-RateLimit-Limit - your current rate limit
X-RateLimit-Remaining - number of calls left in current duration
X-RateLimit-Reset - seconds until the rate limiting period ends
Retry-After - number of seconds after you should retry the call

انواع کلید API

درخواست‌ها با روش HTTP Bearer احراز هویت می‌شن: کلید رو توی هدر Authorization: Bearer YOUR_API_KEY بفرستید.

سه نوع کلید API داریم:

  • کلید اصلی API: اجازه‌ی استفاده از همه‌ی متدهای API روی همه‌چیزِ حساب رو می‌ده.
  • کلیدهای مخصوص مانیتور: فقط اجازه‌ی استفاده از متد getMonitor (و متدهای GET زیرمجموعه‌اش) رو برای همون مانیتور می‌ده.
  • کلید API فقط‌خواندنی: اجازه‌ی خوندن داده با همه‌ی متدهای GET API رو می‌ده.

کلید API رو از کجا بگیرم؟

کلیدهای API رو می‌تونید از صفحه‌ی یکپارچه‌سازی‌ها توی بخش API بگیرید.