تخطَّ إلى المحتوى
نسخة تجريبية

رموز API

كل ما يمكنك فعله في لوحة التحكم — تشغيل مثيل، سردها، قراءة تفاصيل الاتصال، التشغيل والإيقاف، النسخ الاحتياطي، تنفيذ الاستعلامات — مبني على الواجهة البرمجية نفسها. ورموز مساحة العمل تتيح لك استدعاءها من نصوصك البرمجية ومن CI ومن وكلاء الذكاء الاصطناعي.

أنشئ رمزاً

من مساحة عملك، افتح صفحة رموز API وأنشئ رمزاً جديداً. اختر اسماً وانسخ القيمة فوراً — تُعرض مرة واحدة فقط، ولا تعرض القائمة بعدها إلا أول أحرف منها. ويمكنك إلغاء أي رمز في أي وقت من الصفحة نفسها؛ يتوقف عن العمل فوراً.

حدّد صلاحياته

ليس على الرمز أن يرث كل ما تستطيعه أنت. يعرض نموذج الإنشاء موارد المنصّة — النسخ والمشاريع والشبكات والوحدات التخزينية والنطاقات ومفاتيح SSH والرموز — والإجراءات المتاحة على كل مورد، فتختار ما يحتاجه هذا الرمز بالضبط:

الموردالإجراءات
instanceإنشاء، قراءة، تعديل، حذف، دورة حياة، نسخ احتياطي، استعلام
projectإنشاء، قراءة، تعديل، حذف
network، volume، domainإنشاء، قراءة، تعديل، حذف
sshKeyإنشاء، قراءة، حذف
apiKeyإنشاء، قراءة، تعديل، حذف

وفصل lifecycle (تشغيل/إيقاف/إعادة تشغيل) وquery (تنفيذ SQL) عن بقية العمليات مقصود: تشغيل خادم وتنفيذ جملة عليه خطر مختلف عن قراءة بياناته الوصفية، وسكربت النشر عادةً يريد أحدهما دون الآخر.

وثمة قاعدتان تحدّان ما يمكنك إصداره:

  • لا يتجاوز الرمز أبداً الدور الذي أنشأه. يُتقاطع اختيارك مع دورك — فرمز المشاهد يقرأ مهما اخترت.
  • لا يحمل الرمز صلاحيات إدارة مساحة العمل. لا يستطيع دعوة أعضاء أو تغيير أدوار أو حذف مساحة العمل التي أصدرته، أياً كان من أنشأه.

وامنح الرمز مدة صلاحية — حتى سنة — فيتوقف من تلقاء نفسه إن نسيته. فرمز CI الذي يعمّر أطول من الخط الذي كُتب له هو أكثر ما يُتوقّع تسريبه.

استخدمه

أرفقه في ترويسة x-api-key في طلباتك:

bash
curl "https://api.sahabti.com/v1/servers?orgId=$WORKSPACE_ID" \
  -H "x-api-key: $SAHABTI_TOKEN"

وإنشاء مثيل بالشكل نفسه:

bash
curl -X POST https://api.sahabti.com/v1/servers \
  -H "x-api-key: $SAHABTI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"engine":"postgres","name":"orders","plan":"small","orgId":"'"$WORKSPACE_ID"'"}'

وتغطي المسارات النسخ (الإنشاء والسرد والقراءة والتشغيل والإيقاف وإعادة التشغيل وإعادة التسمية وتغيير الحجم وإعادة المحاولة والحذف وتفاصيل الاتصال وسجل التجهيز والمقاييس واستخدام الحصة وتنفيذ SQL)، والنسخ الاحتياطية، والشبكات، والمشاريع وعمليات نشرها، وطلبات زيادة الحصة. وتنشر الواجهة البرمجية مرجعها الكامل على المسار /docs.

وعمليات الكتابة تسجّل النية وتردّ فوراً — ثم تصل المنصّة إليها. فالسكربت الذي ينشئ مثيلاً ينبغي أن يستعلم عنه حتى يصبح قيد التشغيل، لا أن يفترض أن السطر التالي يمكنه الاتصال به.

الخطوات التالية