ابدأ من هنا
ابدأ التكامل مع منصة EAMS في دقائق.
1الخطوة الأولى — احصل على مفتاح API
تُصدَر مفاتيح API لكل مستأجر (Tenant). تواصل مع فريق منصة EAMS للحصول على مفتاح مخصص لاحتياجات التكامل الخاصة بك.
2الخطوة الثانية — فهم آلية المصادقة
يجب أن يتضمن كل طلب مفتاح API في ترويسة x-api-key. المفاتيح مرتبطة بمستأجر محدد — تُصفَّى الاستجابات تلقائياً لتعرض بيانات مستأجرك فقط.
x-api-key: YOUR_API_KEYمفتاح API الخاص بك مرتبط بمستأجر واحد. أي محاولة للوصول إلى بيانات مستأجر آخر تُعيد خطأ 403 Forbidden.
3الخطوة الثالثة — أرسل أول طلب
تحقق من صحة مفتاحك بالاتصال بنقطة نهاية فحص صحة خدمة Auth:
curl -X GET "https://api.innovask.com/ba-auth/api/v1/health" \
-H "x-api-key: YOUR_API_KEY"الاستجابة المتوقعة (200 OK)
{
"status": "Healthy"
}4الخطوة الرابعة — استكشف مرجع API
تصفح جميع نقاط النهاية المتاحة، مخططات الطلب/الاستجابة، وجرّب الطلبات بشكل تفاعلي في مرجع API.
مرجع واجهة برمجة التطبيقاتحدود معدل الطلبات
تُطبّق البوابة حدوداً لمعدل الطلبات لكل مفتاح. تجاوز الحد يُعيد 429 Too Many Requests. نفّذ Exponential Backoff في تطبيقك.
صيغة الأخطاء
جميع الأخطاء تتبع بنية JSON موحدة تتضمن رمزاً قابلاً للقراءة آلياً ورسالة بالإنجليزية والعربية.
{
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key.",
"messageAr": "مفتاح API غير صالح أو مفقود."
}