راهنمای استفاده از API

API پارس‌پک به شما این امکان را می‌دهد که مدیریت ساده‌تری روی منابع خود داشته باشید. از طریق این API می‌توانید ماشین‌های مجازی ایجاد کنید؛ تنظیمات شبکه را مدیریت نمایید و به اطلاعات سرورهای خود دسترسی داشته باشید.

برای استفاده از API، ابتدا باید احراز هویت انجام دهید و سپس درخواست‌های HTTP را به Endpoint مشخص‌شده ارسال کنید.

احراز هویت

تمامی درخواست‌ها به API باید شامل یک توکن احراز هویت باشند. برای دریافت توکن مراحل زیر را طی کنید:

1. وارد پنل کاربری پارس‌پک شوید.
2. از منوی سرور ابری به بخش API بروید.
3. توکن احراز هویت خود را ایجاد و کپی کنید.

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

Authorization: Bearer {YOUR_AUTH_KEY}

نکته

اطمینان حاصل کنید که توکن را نزد خود در فضایی امن ذخیره کرده‌اید. قابلیت ادیت یا مشاهده مجدد توکن پس از صدور وجود نخواهد داشت.

متدهای API

API از متدهای استاندارد HTTP برای انجام عملیات‌های مختلف استفاده می‌کند:

متد	توضیح
GET	دریافت اطلاعات منابع
POST	ایجاد منابع جدید
PUT	به‌روزرسانی منابع موجود
DELETE	حذف منابع

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

ایجاد ماشین مجازی

ایجاد یک ماشین مجازی جدید با استفاده از درخواست POST:

curl --location 'https://my.abrha.net/cserver/api/public/v1/vms?XDEBUG_SESSION_START=amirh' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
--header 'Authorization: Bearer {YOUR_AUTH_KEY}' \
--data '{
    "name": "example-VM",
    "region": "tehran11",
    "size": "irLinuxVPS4",
    "image": "ubuntu24-cloudinit-qcow2"
}'

دریافت لیست پلن‌ها

دریافت لیست پلن‌ها با استفاده از درخواست GET:

curl --location 'https://my.abrha.net/cserver/api/public/v1/vms?page=1&per_page=20' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
--header 'Authorization: Bearer {YOUR_AUTH_KEY}'

وضعیت کدهای HTTP

API در پاسخ به درخواست‌ها از کدهای وضعیت استاندارد HTTP استفاده می‌کند:

کد	توضیح
200	درخواست موفقیت‌آمیز بود
400	درخواست نامعتبر
401	احراز هویت ناموفق
404	منبع یافت نشد
500	خطای داخلی سرور

نکات امنیتی

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

برای اطلاعات بیشتر به مستندات کامل API مراجعه کنید:
docs.parspack.com/reference/API