مرجع واجهة API
وثائق المطورين للوصول البرمجي إلى Architecto
تتيح لك واجهة API في Architecto إنشاء تطبيقات وتكاملات ومسارات عمل مخصصة بالاعتماد على المنصة.
المصادقة
تتطلب جميع طلبات API المصادقة باستخدام مفتاح API:
Authorization: Bearer YOUR_API_KEYإنشاء مفتاح API
- انتقل إلى الإعدادات ← المطور ← مفاتيح API
- انقر على إنشاء مفتاح جديد
- أدخل الاسم ومدة الصلاحية (بلا انتهاء، أو 30 يومًا، أو 90 يومًا، أو سنة)
- حدد نطاقات الصلاحيات (القراءة، والكتابة، والإدارة)
- انسخ المفتاح (يظهر مرة واحدة فقط)
لا تشارك مفتاح API علنًا مطلقًا. تعامل معه كما تتعامل مع كلمة المرور.
إلغاء مفتاح API
- انتقل إلى الإعدادات ← المطور ← مفاتيح API
- انقر على إلغاء بجوار المفتاح
- يسري الإلغاء فورًا
عنوان URL الأساسي
تتوفر جميع نقاط نهاية API على العنوان:
https://api.architecto.dev/v1نقاط النهاية الشائعة
المصادقة
POST /auth/login # Login and get session
POST /auth/logout # End session
POST /auth/refresh # Refresh access tokenالمعماريات
GET /architectures # List your architectures
POST /architectures # Create new architecture
GET /architectures/{id} # Get architecture details
PUT /architectures/{id} # Update architecture
DELETE /architectures/{id} # Delete architecture
GET /architectures/{id}/versions # Get version historyالتحليل
POST /architectures/{id}/analyze/cost # Run cost analysis
POST /architectures/{id}/analyze/scalability # Run scalability analysis
POST /architectures/{id}/analyze/threats # Run threat modelingالتوثيق
POST /architectures/{id}/documents/rfc # Generate RFC
POST /architectures/{id}/documents/adr # Generate ADR
POST /architectures/{id}/documents/runbook # Generate runbookالمشاركة
POST /architectures/{id}/shares # Create share link
GET /shares/{token} # Get shared architecture
POST /shares/{token}/comments # Add comment to shared archالفرق
GET /organizations # List your organizations
POST /organizations # Create organization
GET /organizations/{id}/members # List team members
POST /organizations/{id}/invites # Invite team memberمعالجة الأخطاء
تعيد أخطاء API رموز حالة HTTP القياسية:
{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "Architecture with id 'arch_123' not found",
"details": {
"resource_type": "architecture",
"resource_id": "arch_123"
}
}
}رموز الحالة الشائعة
| الرمز | المعنى |
|---|---|
| 200 | نجاح |
| 400 | طلب غير صالح (معلمات غير صالحة) |
| 401 | غير مصادق عليه (مفتاح API غير صالح) |
| 403 | محظور (صلاحيات غير كافية) |
| 404 | غير موجود |
| 429 | تجاوز حد معدل الطلبات |
| 500 | خطأ في الخادم |
تحديد معدل الطلبات
تخضع طلبات API لحدود المعدل التالية:
- خطة Free: 100 طلب/ساعة
- خطة Pro: 1,000 طلب/ساعة
- خطة Ultimate: 10,000 طلب/ساعة
توجد معلومات حدود المعدل في ترويسات الاستجابة:
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200مثال: إنشاء معمارية وتحليلها
# 1. Create architecture
curl -X POST https://api.architecto.dev/v1/architectures \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "E-commerce Platform",
"description": "Multi-region e-commerce with real-time inventory",
"cloud_provider": "aws"
}'
# Response:
# {
# "id": "arch_abc123",
# "title": "E-commerce Platform",
# "created_at": "2024-01-15T10:30:00Z"
# }
# 2. Run cost analysis
curl -X POST https://api.architecto.dev/v1/architectures/arch_abc123/analyze/cost \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"scale_points": [1000, 10000, 100000],
"region": "us-east-1"
}'
# Response:
# {
# "analysis_id": "analysis_xyz789",
# "estimates": [
# {
# "users": 1000,
# "monthly_cost": 150,
# "breakdown": { "compute": 80, "storage": 40, "data_transfer": 30 }
# },
# ...
# ]
# }Webhooks (قريبًا)
اشترك في أحداث المعمارية:
POST /webhooks
{
"url": "https://your-app.com/webhook",
"events": ["architecture.created", "architecture.updated", "analysis.completed"]
}حزم SDK
ستتوفر قريبًا حزم SDK رسمية للغات:
- Python
- Node.js / TypeScript
- Go
- Ruby
- Java
وثائق API التفاعلية
جرّب واجهة API دون كتابة شيفرة:
- مجموعة Postman
- Swagger UI
- GraphQL Playground (قريبًا)
الدعم
- مشكلات API: أبلغ عنها في GitHub Issues
- الأسئلة: اطرحها في مجتمع Discord
- المؤسسات: تواصل عبر sales@architecto.dev
الخطوات التالية:
- دليل التكاملات
- إعداد Webhooks (قريبًا)