एपीआई दस्तावेज़

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 हेडर में अपना टोकन शामिल करें।

महत्वपूर्ण: अपना टोकन कभी साझा न करें और न ही उसे क्लाइंट-साइड कोड में रखें जहाँ दूसरे उसे पढ़ सकें। उसे अपने सर्वर पर ही रखें।

एंडपॉइंट

POST/api/v1/auth/registerनया उपयोगकर्ता खाता बनाएँ

POST/api/v1/auth/loginसाइन इन करें और एक्सेस टोकन पाएँ

GET/api/v1/labsउपयोगकर्ता की लैब रिपोर्ट सूचीबद्ध करें

POST/api/v1/labs/uploadनई लैब रिपोर्ट अपलोड करें (PDF या छवि)

GET/api/v1/foodsभोजन डेटाबेस खोजें

GET/api/v1/recommendationsव्यक्तिगत भोजन सुझाव प्राप्त करें

दर सीमाएँ

एपीआई सबके लिए तेज़ और निष्पक्ष बनी रहे, इसलिए अनुरोध तीन अतिव्यापी अवधियों में सीमित हैं। तीनों एक साथ लागू होती हैं।

प्रति सेकंड

प्रति 10 सेकंड

100

प्रति मिनट

ये सेवा के डिफ़ॉल्ट मान हैं; संचालक इन्हें और घटा सकता है।

मदद चाहिए?

हमारी टीम एपीआई के साथ निर्माण में आपकी मदद के लिए मौजूद है।

सहायता से संपर्क करें