مرجع API

هر وب سرویس آریانت یک سند OpenAPI دارد که همه endpointها، پارامترها، بدنه‌ها، پاسخ‌ها و کدهای خطا را توصیف می‌کند. مرجع تعاملی از روی همین سند ساخته می‌شود و می‌توانید در آن endpointها را جستجو کنید.

وب سرویس	آدرس پایه	مرجع تعاملی	OpenAPI	Scopeها	راهنما
ابر آریانت	https://api.ariaservice.net/cloud/v1	مرجع	JSON	cloud:servers:*	ابر
سرور مجازی (VPS)	https://api.ariaservice.net/api/v1	مرجع	YAML	servers:*، regions:read، ...	VPS
VPS منطقه‌ای	https://api.ariaservice.net/vps/v1	مرجع	JSON	vps:servers:*	VPS منطقه‌ای
هاستینگ	https://api.ariaservice.net/hosting/v1	مرجع	JSON	hosting:accounts:*	هاستینگ
سرور اختصاصی	https://api.ariaservice.net/baremetal/v1	مرجع	JSON	baremetal:servers:*	سرور اختصاصی
پیامک	https://api.ariaservice.net/sms/v1	مرجع	JSON	sms:*	پیامک

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

ساخت کلاینت از روی OpenAPI

با هر ابزار OpenAPI می‌توانید برای زبان خودتان کلاینت بسازید. نمونه با OpenAPI Generator:

npx @openapitools/openapi-generator-cli generate \
  -i https://api.ariaservice.net/cloud/v1/openapi.json \
  -g python -o ./arianet-cloud-client

یا وارد کردن سند در Postman / Insomnia: Import ← Link و آدرس سند OpenAPI را بدهید، سپس در تنظیمات احراز هویت نوع Bearer Token را با توکن خود انتخاب کنید.

نسخه‌های این سایت

مرجع‌های تعاملی از نسخه‌ای از سند می‌خوانند که همراه این سایت منتشر می‌شود (وب سرویس‌ها هدر CORS نمی‌فرستند). منبع حقیقت، سندی است که خود وب سرویس در /openapi.json برمی‌گرداند.