واجهة API للباركود

Integrate barcode lookup and analysis directly into your applications.

POST

1. المصادقة

تتيح نقطة النهاية هذه للمستخدمين المصادقة والحصول على رمز وصول. الرمز مطلوب لإرسال طلبات API اللاحقة.

/api/auth/getToken
Request Body
{
  "userKey": "YOUR_USER_KEY",
  "apiKey": "YOUR_API_KEY"
}
جرّبها
POST

2. جلب الباركود

تتيح لك نقطة النهاية هذه جلب تفاصيل باركود معيّن، بما في ذلك اسم المنتج ومعلومات السعر والتوفر.

التفويض:: يتطلب هذا الطلب رمزًا صالحًا في
/api/barcode
Request
{
  "barcode": "8690632994802"
}
Response Example
[
  {
    "barcode": "8690...",
    "text": "Product Name...",
    "prices": []
  }
]
جرّبها
Auth
* Auto-filled from Authentication step
الباركود

                            
POST

3. القيم الغذائية

السعرات والدهون والكربوهيدرات والبروتين والسكريات والصوديوم والفيتامينات والمعادن في المنتج، لكل 100 غ (أو 100 مل) ولكل حصة، مع المكوّنات. البيانات من USDA FoodData Central وOpen Food Facts. يُحتسب كل طلب ضمن حصتك اليومية، مثل البحث عن باركود.

التفويض:: يتطلب هذا الطلب رمزًا صالحًا في
/api/nutrition
Request
{
  "barcode": "0016000275287"
}
ملاحظات
  • الوحدات: الطاقة بالسعرات (kcal)؛ والعناصر الغذائية بالغرام أو الملليغرام أو الميكروغرام (µg).
  • تكون servingSize وservingUnit وperServing فارغة عندما لا يذكر المصدر حجم الحصة.
  • dailyValue: النسبة من القيمة اليومية الأمريكية (نظام 2000 سعرة)؛ فارغة إن لم توجد.
  • 404 مع {"error": "NO_NUTRITION_FACTS"} عندما لا تتوفر لدينا قيم غذائية للمنتج.
  • source: usda-fdc أو openfoodfacts. بيانات Open Food Facts خاضعة لترخيص ODbL: اذكر Open Food Facts حيث تعرضها.
Response Example
{
  "barcode": "0016000275287",
  "source": "usda-fdc",
  "servingSize": 40.0,
  "servingUnit": "g",
  "householdServing": "1 cup (40 g)",
  "packageWeight": "18 oz",
  "category": "Cereal",
  "ingredients": "Whole grain oats, sugar, ...",
  "nutrients": [
    { "key": "energy", "unit": "kcal",
      "per100": 375.0, "perServing": 150.0,
      "dailyValue": null },
    { "key": "fat", "unit": "g",
      "per100": 5.0, "perServing": 2.0,
      "dailyValue": 3 },
    { "key": "sodium", "unit": "mg",
      "per100": 475.0, "perServing": 190.0,
      "dailyValue": 8 }
  ]
}

مفاتيح العناصر الغذائية: energy وfat وsaturatedFat وtransFat وcholesterol وsodium وcarbohydrate وfiber وsugars وaddedSugars وprotein وvitaminD وcalcium وiron وpotassium (بترتيب الملصق الأمريكي؛ فقط ما يذكره المنتج).

جرّبها
Auth

                            
POST

4. تحليل الباركود

تحلّل نقطة النهاية هذه الباركود المُرسَل وتعرض تفاصيل مثل بلد المنشأ ورمز الشركة المصنِّعة ورمز المنتج.

/api/analysis
جرّبها
Auth
الباركود