🔑API حالة مفتاح API
تسمح لك واجهة برمجة التطبيقات (API) هذه بالتحقق من حالة مفتاح واجهة برمجة التطبيقات (API) الخاص بك. تقوم بإرجاع معلومات مثل ما إذا كان مفتاح API نشطًا والبروتوكول المرتبط وتفاصيل أخرى.
ملحوظة:
قم دائمًا بتضمين صالحapi_keyفي رؤوس الطلبات إذا كان المفتاح مفقودًا أو غير صالح، فسوف تتلقى رسالة 404 Not Foundإجابة.
- 🔹 تتطلب واجهة برمجة التطبيقات هذهمفتاح واجهة برمجة التطبيقاتللمصادقة.
- 🔹 يجب إرسال مفتاح API عبرheaderولم تعد معلمات الاستعلام مستخدمة.
💡 طلب مثال
GET https://core.dinakel.com/api/gateway/v1/api-key/status
Headers:
Authorization: Bearer <your_api_key>
🔍 الرد المثالى
{
"status": true,
"statusCode": 200,
"data": {
"apiKeyStatus": "active"
}
}
⚠️ معالجة الأخطاء
قد تقوم واجهة برمجة التطبيقات (API) بإرجاع استجابات الخطأ التالية:
{
"status": false,
"statusCode": 401,
"message": "Unauthorized"
}
401 Unauthorized:رأس api_key مفقود أو غير صالح. تأكد من توفير مفتاح صالح.
{
"status": false,
"statusCode": 401,
"message": "Unauthorized"
}
401 Unauthorized:لم يتم العثور على مفتاح API المقدم. تحقق مرة أخرى من المفتاح وحاول مرة أخرى.
{
"status": false,
"statusCode": 500,
"message": "Internal server error"
}
500 Internal Server Error:حدث خطأ غير متوقع في الخادم. حاول مرة أخرى لاحقًا أو اتصل بالدعم.