REST API

ابنِ فوق مشاريعك في Skimle

نقاط نهاية JSON لقراءة بيانات المشاريع وكتابتها، ولتشغيل مشروع من بدايته إلى نهايته. صادِق بمفتاح Bearer، وأرسل action، واحصل على JSON.

ابدأ في ثلاث خطوات

من الصفر إلى أول طلب مصادَق عليه.

1

أنشئ مفتاح API

يصل مفتاح المشروع إلى مشروع واحد، ويصل مفتاح الحساب إلى فريق واحد ويمكنه إنشاء مشاريع فيه. ويأتي كلاهما بمستويي قراءة وتعديل.

  1. 1. افتح صفحة مفاتيح API
  2. 2. اختر المشروع الذي سيصل إليه المفتاح وحدّد صلاحية القراءة أو التعديل
  3. 3. انسخ المفتاح، فـ Skimle لا يحتفظ إلا بقيمة التجزئة الخاصة به

انسخ المفتاح فورًا.

تظهر قيمة المفتاح كاملة مرة واحدة عند الإنشاء. وبعد إغلاق النافذة لا يبقى لدينا إلا قيمة التجزئة، ولا بد من إعادة إصدار أي مفتاح مفقود.

2

أرسل طلبك الأول

مرّر المفتاح رمز Bearer والـ action في متن JSON. كل نقاط النهاية تستقبل JSON وتُرجع JSON.

curl -X POST https://app.skimle.com/api/skimle-read \
  -H "Authorization: Bearer skm_…r" \
  -H "Content-Type: application/json" \
  -d '{ "action": "get_categories" }'

تنتهي مفاتيح القراءة بالحرف r ومفاتيح التعديل بالحرف e. تستدعي مفاتيح المشاريع /api/skimle-read و/api/skimle-write، وتستدعي مفاتيح الحساب /api/skimle-account.

3

افتح مرجع API

تصفّح كل نقاط النهاية مع الأوصاف وأشكال الطلبات ولوحة للتجربة. يقبل كل مسار متنًا من نوع discriminated union مفتاحه action.

مواصفات OpenAPI 3.1 الخام متاحة على /api/openapi.json.

هل أنت مستعد للبناء؟

أدِر مفاتيح مشاريعك، أو اطّلع على خادم MCP للعملاء الوكيليين.