إنتقل إلى المحتوى الرئيسي

نظرة عامة على API

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

عنوان URL الأساسي​

https://api.archicore.io/api/v1

المصادقة​

تتطلب جميع طلبات API المصادقة باستخدام رمز Bearer:

curl -H "Authorization: Bearer مفتاح_API_الخاص_بك" \
  https://api.archicore.io/api/v1/projects

راجع المصادقة للحصول على تفاصيل حول الحصول على مفاتيح API.

تنسيق الاستجابة​

جميع الاستجابات بتنسيق JSON:

{
  "success": true,
  "data": { ... }
}

استجابات الخطأ:

{
  "success": false,
  "error": "رسالة الخطأ",
  "code": "رمز_الخطأ"
}

رموز حالة HTTP​

الرمزالوصف
200نجاح
201تم الإنشاء
400طلب غير صالح - معلمات غير صالحة
401غير مصرح - رمز غير صالح أو مفقود
403محظور - صلاحيات غير كافية
404غير موجود
429طلبات كثيرة جداً - تم تجاوز حد المعدل
500خطأ داخلي في الخادم

حدود المعدل​

المستوىطلبات/يومطلبات/دقيقة
مجاني10010
Pro10,000100
Enterpriseغير محدود1,000

يتم تضمين رؤوس حد المعدل في جميع الاستجابات:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640000000

ملخص نقاط النهاية​

المشاريع​

الطريقةنقطة النهايةالوصف
GET/projectsعرض جميع المشاريع
POST/projectsإنشاء مشروع
GET/projects/:idالحصول على تفاصيل المشروع
DELETE/projects/:idحذف مشروع
POST/projects/:id/indexبدء الفهرسة

التحليل​

الطريقةنقطة النهايةالوصف
POST/projects/:id/searchالبحث الدلالي
POST/projects/:id/askسؤال مساعد الذكاء الاصطناعي
GET/projects/:id/metricsالحصول على مقاييس الكود
GET/projects/:id/securityنتائج فحص الأمان
POST/projects/:id/analyzeتحليل التأثير

Webhooks​

الطريقةنقطة النهايةالوصف
GET/webhooksعرض webhooks
POST/webhooksإنشاء webhook
DELETE/webhooks/:idحذف webhook

حزم SDK​

حزم SDK الرسمية متاحة لـ:

  • JavaScript/TypeScript: npm install @archicore/sdk
  • Python: pip install archicore

مثال سريع​

import { ArchiCore } from '@archicore/sdk';

const client = new ArchiCore({ apiKey: 'مفتاح_API_الخاص_بك' });

// البحث في الكود
const results = await client.projects.search('project-id', {
  query: 'منطق المصادقة'
});

// سؤال الذكاء الاصطناعي
const answer = await client.projects.ask('project-id', {
  question: 'كيف يعمل نظام المصادقة؟'
});