واجهة API العامة

المطورون

واجهة API العامة

نقاط نهاية REST للمشاريع والمهام والسبرنتات والنشاط — مصادقة بمفتاح API حامل.

واجهة API العامة

Skrum هو منصة التحكم الشاملة بالمشاريع بالذكاء الاصطناعي — دردشة الفريق، والمهام والسبرنتات، واجتماعات الفيديو الأصلية، ونشاط الكود الوارد، كل ذلك في مساحة عمل واحدة، مع انتظار كل إجراء ذكاء اصطناعي لموافقة بشرية.

أنشئ مفتاح API في الإعدادات ← مفاتيح API — يُعرض مرة واحدة. أرسله كرمز حامل (bearer) إلى /api/v1. تعيد كل نقطة نهاية قائمة { data, nextCursor }؛ مرّر nextCursor مجددًا كـcursor للصفحة التالية (الحد 1–100، والافتراضي 25). مغلَّف الخطأ هو { error: { code, message } }. المخطط الكامل على /api/v1/openapi.json.

نقاط النهاية

  • GET /projects
  • GET /projects/{key}
  • GET /projects/{key}/tasks
  • GET /projects/{key}/sprints
  • GET /projects/{key}/activity
  • GET /tasks/{ref} (مثل WEB-42)
  • POST /tasks

جرّب بنفسك

curl -H "Authorization: Bearer $SKRUM_API_KEY" https://your-workspace.example/api/v1/projects
curl -H "Authorization: Bearer $SKRUM_API_KEY" https://your-workspace.example/api/v1/tasks/WEB-1
curl -H "Authorization: Bearer $SKRUM_API_KEY" -H "Content-Type: application/json" \
  -d '{"projectKey":"WEB","title":"Ship the docs"}' https://your-workspace.example/api/v1/tasks

الأسئلة الشائعة

  • الباقة؟ باقة Agency لواجهة REST (راجع الباقات).
  • حدود المعدّل؟ لكل رمز، قابلة للضبط عبر متغيرات البيئة؛ الافتراضيات متحفظة.

انظر أيضًا: وثائق Skrum