شروع به کار با مستندات

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

نمونه کد برای یکپارچه‌سازی API

در زیر نمونه کدی جهت یکپارچه‌سازی API در برنامه شما با استفاده از JavaScript آمده است.

// نمونه فراخوانی API با استفاده از JavaScript
fetch('https://api.example.com/data', {
    method: 'GET',
    headers: {
        'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
    }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
                

مقدار YOUR_ACCESS_TOKEN را با توکن واقعی خود جایگزین کنید تا درخواست‌ها معتبر شوند. این کد داده‌های API را دریافت و در کنسول چاپ می‌کند.

۱. دریافت اطلاعات سرویس اصلی (GET)

این endpoint جهت دریافت اطلاعات دقیق مربوط به سرویس اصلی (والد) کاربر استفاده می‌شود. آدرس: https://api.iranmonitor.net/1.0/service/view/
پارامتر ورودی: تنها api_key

نمونه کد PHP

<?php
// نمونه کد PHP جهت دریافت اطلاعات سرویس اصلی
$url = "https://api.iranmonitor.net/1.0/service/view/?api_key=your_api_key";
$response = file_get_contents($url);
echo $response;
?>
                

نمونه کد Python

import requests

url = "https://api.iranmonitor.net/1.0/service/view/"
params = { "api_key": "your_api_key" }
response = requests.get(url, params=params)
print(response.json())
                

نمونه کد cURL

curl "https://api.iranmonitor.net/1.0/service/view/?api_key=your_api_key"
                

۲. دریافت اطلاعات سرورهای اختصاصی (GET)

این endpoint جهت دریافت اطلاعات سرورهای اختصاصی مرتبط با سرویس اصلی کاربر استفاده می‌شود. آدرس: https://api.iranmonitor.net/1.0/server/view/
پارامتر ورودی: تنها api_key

نمونه کد PHP

<?php
// نمونه کد PHP جهت دریافت اطلاعات سرورهای اختصاصی
$url = "https://api.iranmonitor.net/1.0/server/view/?api_key=your_api_key";
$response = file_get_contents($url);
echo $response;
?>
                

نمونه کد Python

import requests

url = "https://api.iranmonitor.net/1.0/server/view/"
params = { "api_key": "your_api_key" }
response = requests.get(url, params=params)
print(response.json())
                

نمونه کد cURL

curl "https://api.iranmonitor.net/1.0/server/view/?api_key=your_api_key"
                

۳. دریافت لیست سرورها (GET)

این endpoint جهت دریافت لیست سرورهای اختصاصی کاربر استفاده می‌شود. آدرس: https://api.iranmonitor.net/1.0/server/node_list/
پارامتر ورودی: تنها api_key

نمونه کد PHP

<?php
// نمونه کد PHP جهت دریافت لیست سرورها
$url = "https://api.iranmonitor.net/1.0/server/node_list/?api_key=your_api_key";
$response = file_get_contents($url);
echo $response;
?>
                

نمونه کد Python

import requests

url = "https://api.iranmonitor.net/1.0/server/node_list/"
params = { "api_key": "your_api_key" }
response = requests.get(url, params=params)
print(response.json())
                

نمونه کد cURL

curl "https://api.iranmonitor.net/1.0/server/node_list/?api_key=your_api_key"
                

۴. دریافت گزارش‌های سرور (GET)

این endpoint جهت دریافت گزارش‌های سرور اختصاصی کاربر استفاده می‌شود. آدرس: https://api.iranmonitor.net/1.0/server/node_data/
پارامترهای ورودی:
- api_key: کلید API سرویس اصلی (والد)
- uuid: شناسه یکتای سرور کاربر
- node_code: کد اختصاصی سرور

نمونه کد PHP

<?php
// نمونه کد PHP جهت دریافت گزارش‌های سرور
$url = "https://api.iranmonitor.net/1.0/server/node_data/?api_key=your_api_key&uuid=server_uuid&node_code=123";
$response = file_get_contents($url);
echo $response;
?>
                

نمونه کد Python

import requests

url = "https://api.iranmonitor.net/1.0/server/node_data/"
params = {
    "api_key": "your_api_key",
    "uuid": "server_uuid",
    "node_code": "123"
}
response = requests.get(url, params=params)
print(response.json())
                

نمونه کد cURL

curl "https://api.iranmonitor.net/1.0/server/node_data/?api_key=your_api_key&uuid=server_uuid&node_code=123"
                

۵. به‌روزرسانی فیلد سرور (POST)

این endpoint جهت به‌روزرسانی یک فیلد از اطلاعات یک سرور اختصاصی کاربر استفاده می‌شود. از این endpoint باید با متد POST استفاده کرد. آدرس: https://api.iranmonitor.net/1.0/server/edit/

پارامترهای ارسالی:
- api_key: کلید API سرویس اصلی (والد)
- related_uuid: شناسه یکتای سرور کاربر
- field: نام فیلدی که می‌خواهید به‌روزرسانی کنید. مقادیر مجاز شامل:
  • ip_subdomain: باید یک دامنه معتبر باشد.
  • port: عدد صحیح بین ۱ تا ۶۵۵۳۵.
  • interval: عدد صحیح بین ۱ تا ۶۰.
  • metric: یکی از مقادیر زیر:
    - dns_resolution_time
    - ttl
    - error_rate
    - query_success_rate
    - validation_time
    - resolution_time
    - record_integrity
    - connection_time
    - throughput
    - packet_loss
    - retransmissions
    - response_time
    - http_status_codes
    - content_size
    - latency
    - ping_time
    - jitter
    - success_rate
  • protocol: یکی از مقادیر زیر:
    - DNS
    - DNSSEC
    - FTP
    - HTTP
    - HTTPS
    - ICMP
    - IPDNS
    - QUIC
    - SFTP
    - SSH
    - TCP
    - TLS
    - V2RAY
- config: رشته (متنی)
- username: رشته با حداکثر ۲۵۵ کاراکتر
- password: رشته با حداکثر ۲۵۵ کاراکتر
- threshold_operator: یکی از عملگرهای <, =, >, <=, >=, !=
- threshold_value: مقدار عددی

- value: مقدار جدید برای فیلد انتخاب شده.

نمونه کد PHP

<?php
// نمونه کد PHP جهت به‌روزرسانی فیلد سرور
$url = "https://api.iranmonitor.net/1.0/server/edit/";
$data = [
    "api_key"      => "your_api_key",
    "related_uuid" => "server_uuid",
    "field"        => "port", // یا هرکدام از مقادیر مجاز: ip_subdomain, port, interval, metric, protocol, config, username, password, threshold_operator, threshold_value
    "value"        => "8080"  // مقدار جدید (مثلاً 8080 برای port)
];
$options = [
    'http' => [
        'header'  => "Content-Type: application/x-www-form-urlencoded\r\n",
        'method'  => 'POST',
        'content' => http_build_query($data),
    ],
];
$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
echo $result;
?>
                

نمونه کد Python

import requests

url = "https://api.iranmonitor.net/1.0/server/edit/"
payload = {
    "api_key": "your_api_key",
    "related_uuid": "server_uuid",
    "field": "port",  # یا یکی از: ip_subdomain, port, interval, metric, protocol, config, username, password, threshold_operator, threshold_value
    "value": "8080"   # مقدار جدید، برای مثال 8080 برای پورت
}
response = requests.post(url, data=payload)
print(response.json())
                

نمونه کد cURL

curl -X POST https://api.iranmonitor.net/1.0/server/edit/ \
-d "api_key=your_api_key" \
-d "related_uuid=server_uuid" \
-d "field=port" \
-d "value=8080"
                

۶. دریافت گزارش‌های فلگ‌شده سرور (GET)

این endpoint جهت دریافت گزارش‌های فلگ‌شده سرور اختصاصی کاربر استفاده می‌شود. آدرس: https://api.iranmonitor.net/1.0/server/node_triggers/
پارامترهای ورودی:
- api_key: کلید API سرویس اصلی (والد)
- uuid: شناسه یکتای سرور کاربر
- node_code: کد اختصاصی سرور

نمونه کد PHP

<?php
// نمونه کد PHP جهت دریافت گزارش‌های فلگ‌شده سرور
$url = "https://api.iranmonitor.net/1.0/server/node_triggers/?api_key=your_api_key&uuid=server_uuid&node_code=123";
$response = file_get_contents($url);
echo $response;
?>
                

نمونه کد Python

import requests

url = "https://api.iranmonitor.net/1.0/server/node_triggers/"
params = {
    "api_key": "your_api_key",
    "uuid": "server_uuid",
    "node_code": "123"
}
response = requests.get(url, params=params)
print(response.json())
                

نمونه کد cURL

curl "https://api.iranmonitor.net/1.0/server/node_triggers/?api_key=your_api_key&uuid=server_uuid&node_code=123"