پرش به مطلب اصلی

معرفی

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


آدرس پایه

https://open.nestcode.org/{api_version}/{api_name}

احراز هویت

برای استفاده از API، باید توکن خود را از طریق پارامتر key به صورت GET ارسال کنید:

https://open.nestcode.org/{api_version}/{api_name}?key={license}

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

[https://open.nestcode.org/v1/sample?key={license}](https://open.nestcode.org/v1/sample?key={license})

نمونه کد

<?php

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

$ch = curl_init("https://open.nestcode.org/v1/ChatGP?" . $params);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

فرمت پاسخ

{
"detail": {
"status": "success", // success, fail
"developer": "t.me/N3x74",
"data": {
// array, string
}
}
}

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

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

کدهای خطا

کد وضعیتپیام خطاتوضیحات
400Bad Requestپارامتر نامعتبر یا ناقص
401Unauthorizedتوکن نامعتبر یا منقضی
404Not Foundمسیر یا منبع مورد نظر یافت نشد
500Internal Server Errorخطا در سرور

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

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

همیشه آدرس پایه (Base URL) و توکن دسترسی (API Key) را در متغیرهای ثابت و مرکزی نگه دارید. این کار باعث افزایش انعطاف‌پذیری و کاهش خطا در توسعه و نگهداری پروژه می‌شود.
برای مثال، در زبان‌های مختلف می‌توانید به صورت زیر عمل کنید:

PHP:

define('API_BASE_URL', 'https://open.nestcode.org/v1/');
define('API_KEY', 'your_token_here');

Python:

API_BASE_URL = "https://open.nestcode.org/v1/"
API_KEY = "your_token_here"

اگر ساختار پروژه‌تان ماژولار است، توصیه می‌شود متغیرها را در فایل .env یا فایل تنظیمات متمرکز ذخیره کنید.

امنیت توکن

توکن احراز هویت شما مانند رمز عبور است؛ در صورت افشا می‌تواند منجر به سوءاستفاده، مصرف بیش‌ازحد منابع یا حتی دسترسی غیرمجاز شود. بنابراین:

  • هرگز توکن را در کدهای سمت کلاینت (مانند JavaScript در مرورگر یا اپلیکیشن موبایل) قرار ندهید.
  • از رمزنگاری و محیط‌های امن مانند متغیرهای محیطی (Environment Variables) یا Secret Manager استفاده کنید.
  • در صورت شک به افشای توکن، آن را بلافاصله لغو کرده و توکن جدید دریافت نمایید.

منابع تکمیلی