مرجع واجهة برمجة التطبيقات

تقع واجهة برمجة التطبيقات العامة على https://api.ara.so/v3. يرتبط مفتاح واجهة برمجة التطبيقات ara_ بمساحة عمل Ara التي أُنشئ فيها.

الحصول على مفتاح واجهة برمجة التطبيقات

1. سجّل الدخول إلى Ara وافتح مساحة عملك.
2. افتح الإعدادات ← Ara CLI.
3. ضمن مفاتيح واجهة برمجة التطبيقات للتكامل المستمر، اختر إنشاء مفتاح.
4. اختر أضيق النطاقات وتاريخ انتهاء الصلاحية، ثم انسخ المفتاح.

التحقق من المفتاح

عيّن المفتاح في الصدفة البرمجية واستدعِ /v3/self:

$
export ARA_API_KEY="ara_..."
$
$
curl https://api.ara.so/v3/self \
>
  -H "Authorization: Bearer $ARA_API_KEY"

تتضمن الاستجابة معرّف المؤسسة المرتبط بالمفتاح:

1
{
2
  "principal_type": "service_user",
3
  "service_user_id": "key_3f9a",
4
  "service_user_name": "ci-bot",
5
  "org_id": "org_8c2d1e"
6
}

استخدم هذه القيمة في الأمثلة المتبقية:

$
export ARA_ORG_ID="org_8c2d1e"

تجربة واجهة برمجة التطبيقات

سرد المستودعات المتصلة

يتطلب repos:read.

$
curl "https://api.ara.so/v3/organizations/$ARA_ORG_ID/repositories" \
>
  -H "Authorization: Bearer $ARA_API_KEY"

بدء جلسة

يتطلب run. استبدل acme/web بمستودع متصل بمساحة العمل.

$
curl "https://api.ara.so/v3/organizations/$ARA_ORG_ID/sessions" \
>
  -H "Authorization: Bearer $ARA_API_KEY" \
>
  -H "Content-Type: application/json" \
>
  -d '{
>
    "repo": "acme/web",
>
    "prompt": "Fix the flaky auth test, add a regression case, and open a PR."
>
  }'

تتضمن الاستجابة session_id. إنشاء الجلسة عملية غير متزامنة.

قراءة الجلسة

يتطلب sessions:read.

$
export ARA_SESSION_ID="ses_91af3c"
$
$
curl "https://api.ara.so/v3/organizations/$ARA_ORG_ID/sessions/$ARA_SESSION_ID" \
>
  -H "Authorization: Bearer $ARA_API_KEY"

النطاقات الشائعة

للاطلاع على حقول الطلب التفصيلية ومخططات الاستجابة وجميع نقاط النهاية العامة، افتح مرجع نقاط النهاية الكامل.

الأخطاء