Skip to content

NFL API دستاویزات

مطابقت پذیر غذائیت کے لیبل پیش کریں، ترکیبوں کا نظم کریں اور غذائیت کے ڈیٹا کو پروگرام کے مطابق کھینچیں۔ آج ہر اس اکاؤنٹ کے لیے دو چیزیں کام کرتی ہیں جو اہل ہے: لائیو لیبل سرایت اور سرور کی طرف سے فراہم کردہ برآمدات. REST ریسورس API بزنس پلان پر ابتدائی رسائی میں ہے۔

API صرف JSON کو قبول کرتا ہے اور واپس کرتا ہے (لیبل رینڈر اینڈ پوائنٹس بائنری فائل کو واپس کرتے ہیں)۔

تعریف

https://nutritionfactlabel.com/api/v1

API اختتامی نقطہ

تمام REST وسائل ایک ورژن والے بیس URL کے تحت رہتے ہیں۔ بریکنگ تبدیلیاں صرف نئے ورژن کے سابقہ کے تحت بھیجی جاتی ہیں۔ ابتدائی رسائی کے دوران آپ کا خیرمقدم ای میل آپ کی کلیدوں کے لیے فعال بنیادی URL کی تصدیق کرتا ہے۔

وسائل کے URL پیٹرن کا خلاصہ

/v1/recipes
/v1/recipes/{RECIPE_ID}
/v1/recipes/{RECIPE_ID}/label.{svg|png|pdf}
/v1/ingredients
/v1/ingredients/{INGREDIENT_ID}
/v1/analyze

تصدیق

میں اپنی خفیہ کلید کے ساتھ ہر درخواست کی تصدیق کریں۔ Authorization ہیڈر کلیدوں کا دائرہ آپ کے اکاؤنٹ میں ہوتا ہے اور آپ کے پلان کے حقدار ہوتے ہیں: وہی سرور سائیڈ گیٹس جیسے ایپ۔

چابیاں خفیہ رکھیں۔ انہیں کبھی بھی کلائنٹ سائڈ کوڈ میں نہ بھیجیں۔ آپ کے پسدید کے ذریعے پراکسی۔ سپورٹ کے ذریعے فوری طور پر لیک ہونے والی کلید کو گھمائیں۔

مثال کی درخواست

curl https://nutritionfactlabel.com/api/v1/recipes \
  -H 'Authorization: Bearer nfl_live_9f30c2...'

شرح کی حد

چیزوں کو منصفانہ اور مستحکم رکھنے کے لیے: 60 درخواستیں فی منٹ فی کلید؛ لیبل رینڈرز کو اضافی طور پر محدود کیا گیا ہے۔ 5 ہم آہنگ; 1 MB پر لاشوں کی درخواست کریں۔ ایک حد سے آگے جو آپ کو ملتا ہے۔ 429 a کے ساتھ Retry-After ہیڈر

مثال کا جواب

HTTP/2 429 Too Many Requests
Retry-After: 22

{ "error": { "code": "rate_limited",
  "message": "Try again in 22 seconds." } }

لائیو لیبل سرایت کریں۔ ابھی دستیاب ہے۔

کسی بھی ویب سائٹ پر ہمیشہ موجودہ لیبل دکھائیں، کوئی API کلید نہیں۔ جنریٹر میں کسی ترکیب پر ایمبیڈ کو فعال کریں (نصیحت کی قطار → ایمبیڈاس کا عوامی ٹوکن حاصل کرنے کے لیے۔

اسکرپٹ ٹیگ اس کی اونچائی کو خودکار سائز دیتا ہے۔ این ایف ایل میں ترکیب کو اپ ڈیٹ کریں اور ہر صفحہ ایمبیڈ اپ ڈیٹس دکھا رہا ہے۔ پیشہ ورانہ اور کاروباری منصوبے؛ ایمبیڈ کو غیر فعال کرنے سے ٹوکن فوری طور پر ختم ہو جاتا ہے۔

تعریف: اسکرپٹ ٹیگ

<script src="https://nutritionfactlabel.com/embed.js"
        data-label="YOUR_EMBED_TOKEN"
        data-width="290"></script>

متبادل: iframe

<iframe
  src="https://nutritionfactlabel.com/embed/TOKEN"
  width="290" height="560" frameborder="0"
  title="Nutrition Facts"></iframe>

لیبل برآمدات ابھی دستیاب ہے۔

SVG/PNG/PDF کو اسی انجن کے ذریعے سرور کی طرف پیش کیا گیا جس میں ایپ کے دروازے پر لاگو کردہ پلان رولز (فارمیٹس، فائل کی قسمیں، واٹر مارک) شامل ہیں۔ اسے اپنے سیشن ٹوکن کے ساتھ براہ راست کال کریں جب تک کہ API کیز عام دستیابی تک نہ پہنچ جائیں۔ بائنری فائل واپس کرتا ہے، یا 403 آپ کے منصوبے سے باہر۔

درون ایپ ایکسپورٹ کے ساتھ برابری پر دو نوٹ۔ ایپ براؤزر میں پیش کرتی ہے، لہذا جب آپ کو بغیر کسی لیبل کے تیار کردہ لیبل کی ضرورت ہو تو اس اختتامی نقطہ کا استعمال کریں۔ اور jpg فی الحال PNG بائٹس واپس کرتا ہے، جبکہ eps اور ai صرف برآمدی فارمیٹس ہیں جو اختتامی نقطہ پیش نہیں کرتا ہے۔

تعریف

POST /functions/v1/export-label
Authorization: Bearer {ACCESS_TOKEN}
Content-Type: application/json

{
  "fileType": "pdf",
  "data": { ...label state },
  "extra": { }
}

ترکیبیں ابتدائی رسائی · کاروبار

بنیادی چیز: اجزاء، سرونگ اور اے label_format (114 ممالک میں 152 فارمیٹس) کمپیوٹنگ تیار کرتے ہیں۔ label: غذائی اجزاء فی دائرہ اختیار میں گول، اجزاء کا بیان، الرجین۔

کلیدی صفات: id, name, servings, serving_weight_g, label_format, label (شماری) embed_enabledٹائم اسٹیمپ

تعریف

GET    /v1/recipes
POST   /v1/recipes
GET    /v1/recipes/{ID}
PUT    /v1/recipes/{ID}
DELETE /v1/recipes/{ID}
GET    /v1/recipes/{ID}/label.pdf

مثال کا جواب

{
  "id": "rcp_2m4k9q",
  "name": "Chocolate Chip Cookies",
  "servings": 12,
  "serving_weight_g": 28,
  "label_format": "standard",
  "label": {
    "calories": 140,
    "total_fat_g": 7,
    "allergens": ["wheat","milk","soy"],
    ...
  },
  "embed_enabled": false
}

اجزاء ابتدائی رسائی · کاروبار

فی 100 گرام غذائیت کے ساتھ حسب ضرورت اجزاء، الرجین پرجاتیوں اور اختیاری لاگت، ایپ میں بنائی گئی چیزوں کے مشابہ، جنریٹر میں تلاش کی جا سکتی ہے۔ USDA اجزاء ایڈریس کے طور پر usda:{fdc_id}; سیٹ "archived": true محفوظ کرنے کے لیے (فہرستوں سے بطور ڈیفالٹ خارج)۔

تعریف

GET    /v1/ingredients
POST   /v1/ingredients
GET    /v1/ingredients/{ID}
PUT    /v1/ingredients/{ID}
DELETE /v1/ingredients/{ID}

مثال کی درخواست

POST /v1/ingredients

{
  "name": "Organic almond flour",
  "nutrients_per_100g": {
    "calories": 571, "total_fat_g": 50,
    "protein_g": 21, "dietary_fiber_g": 10
  },
  "allergens": ["tree_nuts"],
  "cost_per_unit": 12.5, "unit": "kg"
}

غذائیت کا تجزیہ ابتدائی رسائی · کاروبار

ایک نسخہ کو محفوظ کیے بغیر ایک شاٹ تجزیہ۔ وہی لوٹاتا ہے۔ label آبجیکٹ پلس claims: غذائی اجزاء کا دعویٰ ہے کہ اقدار اس کے لیے اہل ہیں (مثال کے طور پر "فائبر کا اچھا ذریعہ") ان کے CFR حوالہ جات کے ساتھ۔ بے مثال نام USDA کے خلاف مماثل ہیں۔

مثال کی درخواست

POST /v1/analyze

{
  "label_format": "standard",
  "servings": 12,
  "serving_weight_g": 28,
  "ingredients": [
    { "ingredient_id": "usda:173410", "grams": 120 },
    { "name": "brown sugar", "grams": 80 }
  ]
}

غلطیاں

روایتی HTTP کوڈز؛ ایرر باڈیز ایک مستحکم مشین کوڈ اور انسانی پیغام کے ساتھ JSON ہیں۔ 400 خراب ان پٹ · 401 خراب کلید · 403 آپ کے منصوبے سے باہر · 404 نہیں ملا / آپ کا نہیں 429 شرح محدود · 500 بیک آف کے ساتھ دوبارہ کوشش کریں۔

مثال کا جواب

{
  "error": {
    "code": "plan_format_not_allowed",
    "message": "The 'eu-1169' label format
      requires the Professional plan."
  }
}

رسائی حاصل کرنا

ایمبیڈ کو کسی کلید کی ضرورت نہیں ہے۔ اسے فی نسخہ فعال کریں (پروفیشنل+)۔ REST API ابتدائی رسائی میں شامل ہے۔ کاروبار منصوبہ: ای میل support@nutritionfactlabel.com آپ کے اکاؤنٹ سے ای میل اور چابیاں ایک کاروباری دن کے اندر فراہم کی جاتی ہیں۔

ایک اختتامی نقطہ غائب ہے جس کی آپ کو ضرورت ہے؟ ہمیں بتائیں۔ ابتدائی رسائی کے شراکت دار روڈ میپ کو آگے بڑھاتے ہیں۔

کاروبار میں اپ گریڈ کریں۔