وب‌سرویس (API)

اصول

آدرس پایه

https://api.turkishvps.com/v1

احراز هویت

توکن را در هدر Authorization: Bearer YOUR_TOKEN بفرستید. آن را در پنل از بخش «توسعه‌دهندگان ← کلیدهای API» بسازید.

توکن‌ها

تا ۱۰ توکن برای هر حساب. هر وقت خواستید هرکدام را باطل کنید.

محدودیت درخواست

۱۲۰ درخواست در دقیقه برای هر حساب.

صورت‌حساب

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

قالب داده

درخواست و پاسخ به‌صورت JSON است. هدر Accept: application/json را بفرستید.

اولین درخواست

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

curl https://api.turkishvps.com/v1/plans \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"

سفارش سرور

رمز روت باید ۸ تا ۱۲ کاراکتر باشد و حرف کوچک، حرف بزرگ، عدد و یکی از کاراکترهای ! # + $ * - داشته باشد.

curl -X POST https://api.turkishvps.com/v1/servers \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"plan_id": 17, "os_id": 5, "label": "web-1", "root_password": "Str0ng#Pass"}'

آدرس‌ها (Endpoints)

حساب و کاتالوگ

سرورها

کیف پول و فاکتورها

تیکت‌های پشتیبانی

خطاها

درخواست ناموفق وضعیت 4xx و یک پاسخ JSON با پیام برمی‌گرداند؛ در خطای اعتبارسنجی هر فیلد جداگانه آمده است.

HTTP/1.1 422 Unprocessable Content
{
  "message": "The root password field format is invalid.",
  "errors": { "root_password": ["The root password field format is invalid."] }
}