وثائق واجهة البرمجة
ابنِ تطبيقات صحية على واجهة برمجة ClapDiet — واجهة REST لتحليل التحاليل وبيانات الأطعمة والتوصيات الغذائية المخصصة.
البدء السريع
1. اطلب الوصول
واجهة برمجة ClapDiet في وصول محدود وليست ذاتية الخدمة بعد: لا يوجد مفتاح تنشئه من إعدادات حسابك. راسلنا وسنجهّز بيانات اعتمادك.
2. وثّق طلبك
أرسل رمزك في ترويسة Authorization مع كل طلب. على سبيل المثال:
curl -X GET https://api.clapdiet.com/api/v1/foods \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json"
3. تعامل مع الاستجابة
كل استجابة بصيغة JSON. تحقق من رمز الحالة: 200 يعني النجاح، بينما ترمز 400 و500 إلى وجود خطأ.
المصادقة
تستخدم واجهة برمجة ClapDiet رموز Bearer. ضع رمزك في ترويسة Authorization مع كل طلب.
مهم: لا تشارك رمزك أبدًا ولا تضعه في شيفرة تعمل لدى العميل حيث يمكن للآخرين قراءته. احتفظ به على خادمك.
نقاط النهاية
/api/v1/auth/registerإنشاء حساب مستخدم جديد/api/v1/auth/loginتسجيل الدخول والحصول على رموز الوصول/api/v1/labsعرض نتائج تحاليل المستخدم/api/v1/labs/uploadرفع نتائج تحاليل جديدة (PDF أو صورة)/api/v1/foodsالبحث في قاعدة بيانات الأطعمة/api/v1/recommendationsالحصول على توصيات غذائية مخصصةحدود المعدل
لإبقاء الواجهة سريعة وعادلة للجميع، تُحدّد الطلبات ضمن ثلاث نوافذ متداخلة. وتُطبَّق الثلاث في آنٍ واحد.
10
في الثانية
50
كل 10 ثوانٍ
100
في الدقيقة
هذه هي القيم الافتراضية التي تُشحن مع الخدمة؛ ويمكن للمشغّل تشديدها.