🔗 توثيق API الخارجي
📖 نظرة عامة
الرابط الأساسي: /api/external
🔐 المصادقة
curl -H "X-API-Key: rc_your_api_key_here" \
/api/external/reports
/api/external/reports
📌 توليد مفتاح جديد
POST /api/external/generate-key
Authorization: Bearer {admin_token}
Authorization: Bearer {admin_token}
⚡ النقاط المتاحة
GET /api/external/reports
| المعامل | النوع | اختياري | الوصف |
|---|---|---|---|
status | string | ✅ | |
since | ISO datetime | ✅ |
curl -H "X-API-Key: rc_..." \
"/api/external/reports?status=active&since=2026-01-01"
"/api/external/reports?status=active&since=2026-01-01"
{
"reports": [...],
"count": 42,
"generated_at": "2026-07-08T..."
}
"reports": [...],
"count": 42,
"generated_at": "2026-07-08T..."
}
GET /api/external/reports/{id}
curl -H "X-API-Key: rc_..." \
"/api/external/reports/abc123"
"/api/external/reports/abc123"
GET /api/external/alerts
| المعامل | النوع | اختياري | الوصف |
|---|---|---|---|
severity | string | ✅ | |
since | ISO datetime | ✅ |
GET /api/external/alerts/{id}
GET /api/external/responders
| المعامل | النوع | اختياري | الوصف |
|---|---|---|---|
online | string | ✅ | |
specialization | string | ✅ |
curl -H "X-API-Key: rc_..." \
"/api/external/responders?online=true&specialization=%D8%A5%D8%B3%D8%B9%D8%A7%D9%81"
"/api/external/responders?online=true&specialization=%D8%A5%D8%B3%D8%B9%D8%A7%D9%81"
GET /api/external/teams
GET /api/external/stats
{
"stats": {
"total_reports": 150,
"active_reports": 12,
"resolved_reports": 98,
"total_responders": 25,
"responders_online": 18,
"total_alerts": 5,
"reports_by_status": {...},
"reports_by_type": {...}
},
"generated_at": "2026-..."
}
"stats": {
"total_reports": 150,
"active_reports": 12,
"resolved_reports": 98,
"total_responders": 25,
"responders_online": 18,
"total_alerts": 5,
"reports_by_status": {...},
"reports_by_type": {...}
},
"generated_at": "2026-..."
}
GET /api/external/inventory
| المعامل | النوع | اختياري | الوصف |
|---|---|---|---|
category | string | ✅ | |
low_stock | string | ✅ |
GET /api/external/shipments
| المعامل | النوع | اختياري | الوصف |
|---|---|---|---|
status | string | ✅ |
POST /api/external/generate-key
⚠️ رموز الأخطاء
| الرمز | المعنى |
|---|---|
| 401 | |
| 404 | |
| 429 | |
| 500 |