SDKهای رسمی آریانت
برای کار با وب سرویسهای آریانت از داخل برنامه خودتان، چهار کتابخانه رسمی (SDK) در دسترس است. هر چهار از روی مستندات OpenAPI منتشرشده ساخته میشوند و همه وب سرویسها را پوشش میدهند: ابر، VPS و VPS منطقهای، هاستینگ، سرور اختصاصی، پیامک و حساب کاربری (توکنها، کلیدهای SSH، فایروالها، موجودی و فاکتورها).
| زبان | بسته | سورس | راهنما |
|---|---|---|---|
| Go | github.com/ariaservice/arianet-go | arianet-go | Go |
| Python | arianet | arianet-python | Python |
| PHP | ariaservice/arianet | arianet-php | PHP |
| JavaScript / TypeScript | arianet | arianet-js | JavaScript |
نسخه فعلی همه SDKها 0.1.0 است و همه با مجوز MIT منتشر شدهاند.
ویژگیهای مشترک
- یک متد برای هر عملیات وب سرویس؛ نام متد همان
operationIdدر مرجع API است (مثلاًlistServers). - احراز هویت با توکن شخصی API: توکن را در پنل بسازید و در متغیر محیطی
ARIANET_TOKENبگذارید؛ SDK آن را خودش میخواند. دسترسیهای لازم هر وب سرویس در احراز هویت و توکن آمده است. - تکرار خودکار روی
429با رعایت هدرRetry-After. اگر سرور زمان انتظار طولانیتری از سقف تنظیمشده بخواهد، خطا بلافاصله برگردانده میشود. - تکرار امن: خطای شبکه و
502/503/504فقط برای درخواستهای خواندنی و درخواستهایی کهIdempotency-Keyدارند تکرار میشود. برای عملیاتی کهIdempotency-Keyمیپذیرند (مثل ساخت سرور) کلید به صورت خودکار ساخته میشود، پس هیچ سفارشی دوبار ثبت نمیشود. - خطاهای نوعدار با کد پایدار خطا (
code) که همیشه با حروف کوچک است (مثلاًinsufficient_balance)، به همراه ثابتهای آمادهErrorCode. رویcodeتصمیم بگیرید، نه روی متن پیام. - ریجن: برای وب سرویسهایی که نصب منطقهای دارند، ریجن با هدر
Arianet-Regionانتخاب میشود (withRegion("iran-1")). - امنیت توکن: آدرس پایه باید
httpsباشد و SDK هیچ redirectی را دنبال نمیکند، پس توکن فقط به سرور API ارسال میشود.
هر SDK روزانه مستندات OpenAPI را بررسی میکند و اگر تغییری باشد، نسخه جدید کد را به صورت خودکار میسازد. برای endpointهایی که هنوز در نسخه SDK شما نیستند، متد عمومی request / Do با همان احراز هویت و تکرار خودکار در دسترس است.
اگر به جای برنامهنویسی دنبال ابزار آماده هستید، CLI و پرووایدر Terraform را ببینید.