این صفحه راهنمای کامل و گام‌به‌گام برای استفاده از APIهای NestCode است. حتی اگر تازه‌کار هستید، با دنبال کردن این مثال‌ها می‌توانید از نقطه پایانی API داده دریافت و پردازش کنید.

آدرس پایه (Base URL)​

تمام درخواست‌ها باید به آدرس پایه زیر ارسال شوند:

https://open.nestapi.ir/{api_version}/{api_name}

مثال:

https://open.nestapi.ir/apis/sample

احراز هویت (Authentication)​

برای استفاده از API، نیاز به API Key دارید که باید در هر درخواست ارسال شود:

https://open.nestapi.ir/{api_version}/{api_name}?key={YOUR_API_KEY}

بدون توکن معتبر، درخواست‌ها با خطای 401 Unauthorized پاسخ داده می‌شوند.

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

https://open.nestapi.ir/apis/sample?key=YOUR_KEY

نمونه کد با مدیریت پاسخ​

<?php
define('API_BASE_URL', 'https://open.nestapi.ir/apis-1/');
define('API_KEY', 'YOUR_KEY');

$params = http_build_query([
    'key' => API_KEY,
    'q' => 'hello world'
]);

$ch = curl_init(API_BASE_URL . "ChatGP?" . $params);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($httpCode == 200) {
    $data = json_decode($response, true); // تبدیل JSON به آرایه PHP
    if ($data['status'] === 'success') {
        echo "خروجی API: ";
        print_r($data['data']); // دسترسی به بدنه اصلی پاسخ
    } else {
        echo "خطا در API: " . $data['data'];
    }
} else {
    echo "خطای HTTP: " . $httpCode;
}
?>

import requests

API_BASE_URL = "https://open.nestapi.ir/apis-1/ChatGP"
API_KEY = "YOUR_KEY"

params = {
"key": API_KEY,
"q": "hello world"
}

response = requests.get(API_BASE_URL, params=params)

if response.status_code == 200:
    data = response.json()  # تبدیل JSON به دیکشنری Python
    if data['status'] == 'success':
        print("خروجی API:")
        print(data['data'])  # دسترسی به بدنه اصلی پاسخ
    else:
        print("خطا در API:", data['data'])
else:
    print("خطای HTTP:", response.status_code, response.text)

curl -s "https://open.nestapi.ir/apis/sample?key=YOUR_KEY"

فرمت پاسخ API​

{
  "status": "success",
  "developer": "t.me/devh3n",
  "data": {
    "message": "Hello World",
    "count": 1
  },
  "detail": "Additional details if available"
}

توضیح کلیدها​

• status – وضعیت پاسخ: success یا fail
• developer – اطلاعات توسعه‌دهنده
• data – بدنه اصلی پاسخ، که می‌تواند رشته، آرایه یا آبجکت باشد
• detail – توضیحات اضافی یا اطلاعات تکمیلی

نمونه نحوه دسترسی به داده‌ها​

PHP:

echo $data['data']['message']; // دسترسی به پیام
echo $data['data']['count'];   // دسترسی به تعداد

Python:

print(data['data']['message'])  # دسترسی به پیام
print(data['data']['count'])    # دسترسی به تعداد

مدیریت خطاها​

همیشه قبل از پردازش داده‌ها، بررسی کنید که status موفق باشد.

نکات امنیتی و فنی​

• از HTTPS استفاده کنید.
• توکن را هیچ‌گاه در سمت کلاینت نمایش ندهید.
• به محدودیت درخواست‌ها (Rate Limit) توجه کنید.
• پاسخ‌ها و خطاها را همیشه مدیریت و لاگ کنید.

define('API_BASE_URL', 'https://open.nestapi.ir/apis/');
define('API_KEY', 'your_token_here');

API_BASE_URL = "https://open.nestapi.ir/apis/"
API_KEY = "your_token_here"

مثال عملی گام‌به‌گام برای تازه‌کارها​

1. ثبت نام و دریافت API Key
2. ذخیره توکن در متغیر مرکزی یا فایل تنظیمات
3. انتخاب زبان برنامه‌نویسی و استفاده از نمونه کدها
4. بررسی پاسخ و دسترسی به data
5. مدیریت خطا و بررسی status
6. نمایش خروجی در برنامه یا وبسایت

منابع تکمیلی​

• مقدمه مستندات
• دریافت توکن از طریق بات تلگرام
• سوالات متداول