البدء السريع للمطورين

استخدم واجهة OpenVPS البرمجية لإدارة خدماتك وملفك الشخصي وفواتيرك ونطاقاتك.

عنوان الإنتاج الأساسي:

text

https://api.openvps.dev/v1

قبل إرسال الطلب

أنشئ API key من صفحة الملف الشخصي في حسابك على OpenVPS.
امنح المفتاح الصلاحية المطلوبة للمسار الذي ستستخدمه.
أرسل المفتاح في ترويسة Authorization، ولا تضعه في تطبيق أو صفحة متاحة للزوار. الـAPI لا يفعّل CORS افتراضيًا.

مثال سريع باستخدام curl

استبدل YOUR_API_KEY بمفتاحك:

bash

curl https://api.openvps.dev/v1/me \
  -H "Authorization: Bearer YOUR_API_KEY"

مثال باستخدام JavaScript

استخدمه في خادمك، وخزّن المفتاح في متغير بيئة مثل OPENVPS_API_KEY:

const response = await fetch("https://api.openvps.dev/v1/services?limit=20&offset=0", {
  headers: {
    Authorization: `Bearer ${process.env.OPENVPS_API_KEY}`,
  },
});

const result = await response.json();

if (!response.ok) {
  throw new Error(`${result.error.code}: ${result.error.message}`);
}

console.log(result.data);

المسارات المتاحة

الطريقة	المسار	الصلاحية المطلوبة
`GET`	`/v1/me`	`profile:read`
`GET`	`/v1/profile`	`profile:read`
`PATCH`	`/v1/profile`	`profile:write`
`GET`	`/v1/services`	`services:read`
`GET`	`/v1/invoices`	`invoices:read`
`GET`	`/v1/domains`	`domains:read`

تقبل مسارات القوائم limit وoffset، مثل ?limit=20&offset=0. قيمة limit الافتراضية 50، والحد الأقصى 100.

تعديل الملف الشخصي

أرسل PATCH مع Content-Type: application/json. الحقول المدعومة: name, phone, account_type, company_name, job_title, website, country, bio.

bash

curl -X PATCH https://api.openvps.dev/v1/profile \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"الاسم الجديد"}'

الأخطاء

عند فشل الطلب، تكون الاستجابة بصيغة JSON وتحتوي على error.code وerror.message وerror.request_id. تحقق من صلاحية المفتاح وصلاحياته، ومن أن المسار يبدأ بـ/v1.

البدء السريع للمطورين ​

قبل إرسال الطلب ​

مثال سريع باستخدام curl ​

مثال باستخدام JavaScript ​

المسارات المتاحة ​

تعديل الملف الشخصي ​