ونش کلاود
ENFA

API: کاتالوگ

فهرست پلن‌های قابل خرید با فیلتر و خواندن نرخ تبدیل فعلی.

نقاط پایانی کاتالوگ عمومی هستند و به کلید نیاز ندارند. پلن‌ها ارائه‌دهندهٔ واقعی و نام پلنِ خودِ ارائه‌دهنده را نشان می‌دهند.

فهرست پلن‌ها

GET /catalog/plans

پلن‌های قابل خرید را با ارائه‌دهنده و نام پلن واقعی، مشخصات و قیمت ریالی فعلی برمی‌گرداند. با پارامترهای query فیلتر کنید.

احراز هویت: ندارد، این نقطهٔ پایانی عمومی است.

پارامترهای query

فیلد نوع مقادیر
provider string
region string
os string
min_price number
max_price number
q string
per_page integer

پاسخ‌ها

  • 200 موفق. برمی‌گرداند: data (فهرستی از CustomerPlan), meta (object).

نمونه

curl -X GET https://veneshcloud.ir/api/catalog/plans \
  -H "Accept: application/json"

دریافت یک پلن

GET /catalog/plans/{customerPlan}

یک پلن را برمی‌گرداند.

احراز هویت: ندارد، این نقطهٔ پایانی عمومی است.

پارامترهای مسیر

فیلد نوع
customerPlan integer

پاسخ‌ها

  • 200 موفق. برمی‌گرداند CustomerPlan.
  • 404 پیدا نشد

نمونه

curl -X GET https://veneshcloud.ir/api/catalog/plans/PLAN_ID \
  -H "Accept: application/json"

نرخ تبدیل فعلی

GET /catalog/fx-current

نرخی را که فعلاً برای تبدیل قیمت پلن‌ها به ریال استفاده می‌شود برمی‌گرداند.

احراز هویت: ندارد، این نقطهٔ پایانی عمومی است.

پاسخ‌ها

  • 200 موفق. برمی‌گرداند: usd (string), rial (integer), fx_rate_id (integer), rate (string), effective_rate (string), buffer_percent (string), as_of (string).
  • 503 موقتاً در دسترس نیست

نمونه

curl -X GET https://veneshcloud.ir/api/catalog/fx-current \
  -H "Accept: application/json"

فهرست مناطق

GET /catalog/regions

مناطق یک ارائه‌دهنده را با نام انگلیسی و فارسی و پرچم برای انتخاب منطقه برمی‌گرداند. عمومی است.

احراز هویت: ندارد، این نقطهٔ پایانی عمومی است.

پارامترهای query

فیلد نوع مقادیر
provider string

پاسخ‌ها

  • 200 موفق. برمی‌گرداند: data (فهرستی از RegionOption).

نمونه

curl -X GET https://veneshcloud.ir/api/catalog/regions \
  -H "Accept: application/json"

فهرست قابلیت‌های اختیاری

GET /catalog/features

می‌گوید آیا در حال حاضر می‌توان دیسک داده سفارش داد و حدود اندازه (min_gb، max_gb، max_per_vm) و ارائه‌دهندگانی که آن را دارند. عمومی است.

احراز هویت: ندارد، این نقطهٔ پایانی عمومی است.

پاسخ‌ها

  • 200 موفق. برمی‌گرداند: data (CatalogFeatures).

نمونه

curl -X GET https://veneshcloud.ir/api/catalog/features \
  -H "Accept: application/json"

اشیاء

فهرست فیلدهای اشیایی که در بالا برگردانده می‌شوند.

CatalogFeatures

فیلد نوع مقادیر
data_disk object

CustomerPlan

فیلد نوع مقادیر
id integer
name string
provider string
plan_name string
region string
os_options فهرستی از string
specs object
usd_equivalent_price string
rial_price integer
fx object
active boolean

RegionOption

فیلد نوع مقادیر
provider string
slug string
name_en string
name_fa string
country_code string
flag string