📡 مرجع API السريع
نظرة سريعة على Base URL، نقاط النهاية الرئيسية، المصادقة، ورموز الحالة.
🌐 Base URL
- الإنتاج: https://omdaa.com/api/v1
- التطوير: http://localhost:5000/api/v1
🔐 المصادقة (Authentication)
- JWT:
Authorization: Bearer YOUR_JWT_TOKEN - API Key:
X-API-Key: omdaa_xxxxxxxxxxxxxxxxxxxxx - إنشاء API Key: POST /api/v1/api-keys/create مع body:
{"name":"My Key","expiresAt":"2025-12-31"}
curl -X POST https://omdaa.com/api/v1/auth/login \
-H "Content-Type: application/json" \
-d '{"email":"user@example.com","password":"SecurePass123"}'
await fetch('https://omdaa.com/api/v1/auth/login', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ email: 'user@example.com', password: 'SecurePass123' })
});
file_get_contents('https://omdaa.com/api/v1/auth/login', false, stream_context_create([
'http' => [
'method' => 'POST',
'header' => 'Content-Type: application/json',
'content' => json_encode(['email' => 'user@example.com', 'password' => 'SecurePass123'])
]
]));
📝 التسجيل وتسجيل الدخول
- POST /api/v1/auth/register — Body: {"email","password","name"}
- POST /api/v1/auth/login — Body: {"email","password"} → Response: {token, user, ...}
📱 الجلسات (Sessions / Instances)
| POST | /api/v1/instances | إنشاء جلسة |
| GET | /api/v1/instances | قائمة الجلسات |
| GET | /api/v1/instances/:sessionId/state | حالة الجلسة |
| GET | /api/v1/instances/:sessionId/qr | QR للربط |
| POST | /api/v1/instances/:sessionId/logout | قطع الاتصال |
✉️ الرسائل (Messages)
- إرسال نص: POST /api/v1/messages/send-text — Body: {sessionId, to, message}
- إرسال صورة: POST /api/v1/messages/send-image
- إرسال ملف: POST /api/v1/messages/send-document
- رسالة تفاعلية: POST /api/v1/messages/send-interactive
- رقم "to" بصيغة دولية بدون + (مثال: 966501234567)
curl -X POST https://omdaa.com/api/v1/messages/send-text \
-H "Authorization: Bearer YOUR_JWT" \
-H "Content-Type: application/json" \
-d '{"sessionId":"sess_xxx","to":"966501234567","message":"مرحبا"}'
await fetch('https://omdaa.com/api/v1/messages/send-text', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_JWT',
'Content-Type': 'application/json'
},
body: JSON.stringify({
sessionId: 'sess_xxx',
to: '966501234567',
message: 'مرحبا'
})
});
file_get_contents('https://omdaa.com/api/v1/messages/send-text', false, stream_context_create([
'http' => [
'method' => 'POST',
'header' => "Authorization: Bearer YOUR_JWT\r\nContent-Type: application/json",
'content' => json_encode([
'sessionId' => 'sess_xxx',
'to' => '966501234567',
'message' => 'مرحبا'
])
]
]));
🔗 الويب هوكس (Webhooks)
تعيين رابط الويب هوك: POST /api/v1/webhooks — Body: {sessionId, url, events اختياري}
أحداث شائعة: message:received, message:send, session:open, session:close, presence.update, chat.updated
🤖 التكامل مع N8N
| GET | /api/v1/integrations/n8n/status |
| POST | /api/v1/integrations/n8n-bot/create |
| GET | /api/v1/integrations/n8n-bot/list/:sessionId |
| PUT | /api/v1/integrations/n8n-bot/:botId |
| DELETE | /api/v1/integrations/n8n-bot/:botId |
📊 رموز الحالة والأخطاء
| 200 | OK |
| 201 | Created |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 429 | Too Many Requests |
| 500 | Internal Server Error |