REST API ऑटोमेशन गाइड

REST API ऑटोमेशन आपको अपने स्वास्थ्य डेटा को किसी भी वेब सेवा में स्वचालित रूप से निर्यात करने की अनुमति देता है जो HTTP POST अनुरोध स्वीकार करती है। यह कस्टम बैकएंड, तृतीय-पक्ष API, या वेबहुक के साथ एकीकरण के लिए आदर्श है।

अवलोकन

REST API ऑटोमेशन HTTP POST अनुरोधों का उपयोग करके आपके स्वास्थ्य डेटा को एक निर्दिष्ट URL एंडपॉइंट पर भेजते हैं। ऑटोमेशन प्रमाणीकरण और कस्टम मेटाडेटा के लिए विन्यास योग्य हेडर के साथ JSON या CSV प्रारूप में डेटा भेज सकता है।

उपयोग के मामले:

• कस्टम बैकएंड सेवाओं के साथ एकीकरण
• वेबहुक पर डेटा भेजना
• तृतीय-पक्ष API के साथ सिंक करना
• कस्टम डैशबोर्ड या विश्लेषण प्लेटफॉर्म बनाना

मुख्य विशेषताएं:

• JSON और CSV दोनों प्रारूपों का समर्थन करता है
• प्रमाणीकरण के लिए कस्टम HTTP हेडर
• विन्यास योग्य अनुरोध टाइमआउट
• ऐतिहासिक डेटा का मैन्युअल निर्यात

सीमाएँ:

• स्वास्थ्य डेटा एक्सेस: iPhone लॉक होने पर ऐप्स को स्वास्थ्य डेटा तक पहुँच की अनुमति नहीं है। ऑटोमेशन केवल तब चलेंगे जब आपका डिवाइस अनलॉक हो। यह Apple द्वारा लगाई गई सीमा है जिसे दरकिनार नहीं किया जा सकता। अधिक जानकारी

• पृष्ठभूमि प्रसंस्करण: iOS बैटरी बचाने के लिए पृष्ठभूमि प्रसंस्करण सीमित करता है। ऑटोमेशन बैकग्राउंड ऐप रिफ़्रेश पर निर्भर करते हैं और निम्न स्थितियों में तुरंत न चल सकते हैं:

  • ऐप के लिए बैकग्राउंड ऐप रिफ़्रेश बंद है
  • डिवाइस लो पावर मोड में है
  • डिवाइस लंबे समय से निष्क्रिय रहा है
  • सिस्टम संसाधन सीमित हैं
  • कई ऐप्स पृष्ठभूमि निष्पादन समय के लिए प्रतिस्पर्धा कर रहे हैं

प्रदर्शन

ध्यान रखें कि iOS मोबाइल डिवाइस पर बहुत सख्त प्रदर्शन सीमाओं के साथ छोटी अवधि के कार्यों के लिए अनुकूलित है। पृष्ठभूमि कार्य आमतौर पर 30 सेकंड के भीतर पूरे होने चाहिए और मेमोरी की खपत सीमित होती है। Health Auto Export उच्च लचीलापन और अनुकूलन प्रदान करता है, इसलिए यह समझना ज़रूरी है कि कुछ कॉन्फ़िगरेशन ऐप के प्रदर्शन और परिणामों को कैसे प्रभावित करते हैं।

• कॉन्फ़िगरेशन: बड़ी मात्रा में डेटा उत्पन्न करने वाले ऑटोमेशन से सिस्टम प्रक्रिया समाप्त कर सकता है और पृष्ठभूमि में ऑटोमेशन न चल सकें। निम्न कॉन्फ़िगरेशन बड़ी मात्रा में डेटा उत्पन्न कर सकते हैं:
  • सभी स्वास्थ्य मेट्रिक्स निर्यात करने के लिए कॉन्फ़िगर किए गए ऑटोमेशन।
    • सिफ़ारिश: केवल वे स्वास्थ्य मेट्रिक्स चुनें जिनमें Apple Health में सहेजा डेटा है और जो आप वास्तव में उपयोग करेंगे। खाली डेटा प्रकार भी प्रदर्शन पर असर डालते हैं। चुनी गई मेट्रिक्स को कई ऑटोमेशन में बाँटने पर भी विचार करें — सिस्टम के लिए प्रबंधन आसान होता है।
  • सेकंड या मिनट में समय समूहन वाले ऑटोमेशन, या डेटा सारांश बंद हो। ऐसी बारीक क्वेरी लंबा समय ले सकती हैं और सिस्टम सीमाओं से टकरा सकती हैं।
    • सिफ़ारिश: अधिकतम विवरण आदर्श लग सकता है, लेकिन प्रत्येक मेट्रिक या डेटा प्रकार के लिए वह स्तर ज़रूरी है या नहीं, विचार करें। अलग सेटिंग्स वाले कई ऑटोमेशन पर विचार करें।
  • बाहरी वर्कआउट (साइकिल, दौड़, हाइकिंग आदि) रूट डेटा के साथ निर्यात करते समय GPS और संबंधित स्वास्थ्य मेट्रिक्स बड़े पेलोड बना सकते हैं।
• पेलोड आकार: विशेष रूप से REST API निर्यात में, बड़े पेलोड सर्वर त्रुटियाँ पैदा कर सकते हैं। सुनिश्चित करें कि आपका बैकएंड संभवतः कई सौ मेगाबाइट के पेलोड संभाल सके।
• सिंक आवृत्ति: होम स्क्रीन पर ऑटोमेशन विजेट जोड़ें ताकि पृष्ठभूमि में ऑटोमेशन सफलतापूर्वक चलें (ऑटोमेशन के लिए विजेट सेट अप करें देखें)।

आवश्यकताएं

• एक वैध URL एंडपॉइंट जो HTTP POST अनुरोध स्वीकार करता है
• प्रमाणीकरण क्रेडेंशियल (यदि आपके एंडपॉइंट द्वारा आवश्यक हो)
• आपके एंडपॉइंट तक पहुंचने के लिए नेटवर्क कनेक्टिविटी

विन्यास

मुख्य नेविगेशन से स्वचालित निर्यात स्क्रीन पर नेविगेट करें, फिर "नया ऑटोमेशन" टैप करें और ऑटोमेशन प्रकार के रूप में "REST API" चुनें।

ऑटोमेशन नाम

अपने ऑटोमेशन के लिए एक वर्णनात्मक नाम दर्ज करें (उदाहरण के लिए, "मेरा बैकएंड API", "वेबहुक एकीकरण")।

सूचनाएं

कॉन्फ़िगर करें कि आप कब सूचनाएं प्राप्त करना चाहते हैं:

• कैश अपडेट पर सूचित करें - कैश किए गए डेटा अपडेट होने पर सूचना प्राप्त करें
• चलने पर सूचित करें - हर बार ऑटोमेशन निष्पादित होने पर सूचना प्राप्त करें

URL विन्यास

पूर्ण URL दर्ज करें जहां आप अपना स्वास्थ्य डेटा भेजना चाहते हैं। यह प्रोटोकॉल (http:// या https://) सहित एक पूर्ण URL होना चाहिए।

URL उदाहरण:

• https://api.example.com/health-data
• https://webhook.site/your-unique-id
• http://localhost:3000/api/health

नोट: URL वैध होना चाहिए और आपके डिवाइस से पहुंच योग्य होना चाहिए। अमान्य URL ऑटोमेशन को चलने से रोकेंगे।

अनुरोध टाइमआउट

HTTP अनुरोधों के लिए एक टाइमआउट अंतराल चुनें। यह निर्धारित करता है कि अनुरोध विफल माने जाने से पहले ऐप कितनी देर तक प्रतिक्रिया की प्रतीक्षा करेगा।

HTTP हेडर

प्रमाणीकरण या मेटाडेटा के लिए कस्टम HTTP हेडर जोड़ें। सामान्य उपयोग के मामलों में शामिल हैं:

• API कुंजी: X-API-Key: your-api-key
• प्राधिकरण टोकन: Authorization: Bearer your-token
• सामग्री प्रकार ओवरराइड: Content-Type: application/json

हेडर जोड़ने के लिए:

1. "हेडर जोड़ें" टैप करें
2. बाएं फ़ील्ड में हेडर कुंजी दर्ज करें
3. दाएं फ़ील्ड में हेडर मान दर्ज करें
4. अतिरिक्त हेडर के लिए दोहराएं

महत्वपूर्ण: प्रत्येक हेडर कुंजी का एक संबंधित मान होना चाहिए। खाली हेडर को अनदेखा कर दिया जाएगा।

डेटा प्रकार सेटिंग्स

डेटा प्रकार

चुनें कि किस प्रकार का स्वास्थ्य डेटा निर्यात करना है:

• स्वास्थ्य मेट्रिक्स - कदम, हृदय गति, नींद और अन्य स्वास्थ्य माप
• वर्कआउट - व्यायाम और फिटनेस गतिविधियां
• लक्षण - स्वास्थ्य लक्षण और स्थितियां
• ईसीजी - इलेक्ट्रोकार्डियोग्राम रीडिंग
• हृदय गति सूचनाएं - उच्च/निम्न हृदय गति घटनाएं
• मन की स्थिति - मूड और मानसिक स्थिति प्रविष्टियां (iOS 18.0+)
• चक्र ट्रैकिंग - मासिक धर्म चक्र और प्रजनन स्वास्थ्य डेटा
• दवाएं - दवा लॉग और अनुपालन (iOS 26.0+)

स्वास्थ्य मेट्रिक्स विन्यास

जब स्वास्थ्य मेट्रिक्स चुना जाता है:

स्वास्थ्य मेट्रिक्स चुनें - चुनें कि कौन से विशिष्ट मेट्रिक्स शामिल करने हैं। आप सभी उपलब्ध मेट्रिक्स चुन सकते हैं या विशिष्ट चुन सकते हैं।

सुझाव: केवल आवश्यक मेट्रिक्स चुनने से प्रसंस्करण समय में सुधार हो सकता है और डेटा आकार कम हो सकता है।

पसंदीदा स्रोत - कॉन्फ़िगर करें कि कई स्रोत समान मेट्रिक प्रदान करते समय कौन से डेटा स्रोतों को प्राथमिकता दी जाए।

वर्कआउट विन्यास

जब वर्कआउट चुना जाता है:

रूट डेटा शामिल करें - स्थान डेटा वाले वर्कआउट के लिए रूट शामिल करने के लिए चालू करें।

वर्कआउट मेट्रिक्स शामिल करें - वर्कआउट के दौरान एकत्र किए गए स्वास्थ्य मेट्रिक्स (हृदय गति, कैलोरी, आदि) शामिल करने के लिए चालू करें।

समय समूहीकरण (वर्कआउट मेट्रिक्स) - निर्यात संस्करण 2 का उपयोग करते समय और वर्कआउट मेट्रिक्स शामिल करें सक्षम होने पर:

• मिनट - वर्कआउट मेट्रिक्स को मिनट के अनुसार समूहीकृत करता है
• सेकंड - वर्कआउट मेट्रिक्स को सेकंड के अनुसार समूहीकृत करता है

निर्यात सेटिंग्स

निर्यात प्रारूप

अपने निर्यात किए गए डेटा के लिए प्रारूप चुनें:

• JSON प्रारूप - नेस्टेड ऑब्जेक्ट के साथ विस्तृत डेटा संरचनाएं प्रदान करता है। API, डेटाबेस और ऐप्लिकेशन के लिए सबसे अच्छा जिन्हें संरचित डेटा की आवश्यकता है। JSON प्रारूप में नींद चरणों और AFib रीडिंग जैसे जटिल डेटा प्रकारों के लिए अधिक विस्तृत जानकारी शामिल है।

• CSV प्रारूप - सारणीबद्ध डेटा प्रदान करता है जिसे स्प्रेडशीट ऐप्लिकेशन में आसानी से आयात किया जा सकता है। सरल डेटा विश्लेषण या जब आपका एंडपॉइंट CSV डेटा की अपेक्षा करता है तो सबसे अच्छा।

नोट: Content-Type हेडर JSON निर्यात के लिए स्वचालित रूप से application/json और CSV निर्यात के लिए multipart/form-data पर सेट किया जाता है।

निर्यात संस्करण

एक निर्यात संस्करण चुनें। संस्करण नियंत्रण आपको अपनी गति से निर्यात के अपडेट किए गए संस्करणों के बीच संक्रमण करने की अनुमति देता है और वर्कफ़्लो को तोड़ने वाले परिवर्तनों को कम करता है।

• संस्करण 1 - लेगेसी प्रारूप, यदि आपके पास मौजूदा वर्कफ़्लो हैं जो इस प्रारूप पर निर्भर करते हैं तो उपयोग करें
• संस्करण 2 - बेहतर वर्कआउट डेटा और अधिक विस्तृत मेटाडेटा विकल्पों के साथ वर्तमान प्रारूप

तिथि सीमा

चुनें कि डेटा कब निर्यात किया जाना चाहिए:

• डिफ़ॉल्ट - पिछले दिन के पूर्ण डेटा प्लस वर्तमान तिथि और समय तक के डेटा को सिंक करता है
• अंतिम सिंक के बाद से - प्रत्येक सिंक पर, अंतिम बार निर्यात चलाए जाने से वर्तमान तिथि और समय तक के सभी डेटा को निर्यात करता है
• आज - वर्तमान तिथि के लिए वर्तमान समय तक के सभी डेटा को सिंक करता है
• कल - पिछले दिन के पूर्ण सभी डेटा को सिंक करता है
• पिछले 7 दिन - पिछले सात दिनों के पूर्ण डेटा को सिंक करता है

डेटा सारांशित करें

स्वास्थ्य मेट्रिक्स डेटा प्रकार के साथ JSON प्रारूप का उपयोग करते समय, डेटा सारांशित करें चालू या बंद करें।

• चालू - एकत्रित डेटा सारांश प्रदान करता है
• बंद - जहां संभव हो वहां असंगठित डेटा प्रदान करता है, व्यक्तिगत डेटा बिंदु दिखाता है

नोट: यह सेटिंग केवल स्वास्थ्य मेट्रिक्स के साथ JSON प्रारूप पर लागू होती है। CSV प्रारूप का उपयोग करते समय या जब कई मेट्रिक्स चुने जाते हैं तो डेटा हमेशा एकत्रित होता है।

समय समूहीकरण

डेटा सारांशित करें सक्षम के साथ JSON प्रारूप का उपयोग करते समय, चुनें कि डेटा को कैसे एकत्रित किया जाना चाहिए।

नोट: CSV प्रारूप हमेशा डेटा को एकत्रित करता है। मिनट और सेकंड-स्तरीय एकत्रीकरण प्रसंस्करण समय और डेटा आकार को काफी बढ़ा सकता है।

बैच अनुरोध और बड़े पेलोड

JSON प्रारूप का उपयोग करते समय, एक बड़े पेलोड के बजाय कई HTTP अनुरोधों में डेटा भेजने के लिए बैच अनुरोध चालू करें।

• चालू — डेटा को कई अनुरोधों में फैलाता है। जब आपके एंडपॉइंट पर पेलोड सीमा, बड़े बॉडी पर टाइमआउट हों या आप डेटा क्रमिक रूप से प्रोसेस करें।
• बंद — सभी डेटा एक अनुरोध में भेजता है। छोटे निर्यात और साधारण वेबहुक के लिए उपयुक्त।

बैच कब सक्षम करें:

• कई स्वास्थ्य मेट्रिक चयनित, लंबी तिथि सीमा, या बारीक समय समूह (मिनट/सेकंड)
• डेटा सारांश बंद है और आप विघटित स्वास्थ्य मेट्रिक निर्यात करते हैं
• आपका सर्वर बड़े POST बॉडी पर त्रुटि या टाइमआउट देता है

नोट्स:

• बैच अनुरोध केवल REST API + JSON पर लागू (CSV नहीं)।
• बैचिंग प्रति अनुरोध पेलोड घटाती है, लेकिन डिवाइस पर डेटा लाने की आवश्यकता नहीं हटाती; धीमी HealthKit क्वेरी गतिविधि लॉग में चेतावनी के रूप में दिख सकती हैं। गतिविधि लॉग में धीमी क्वेरी देखें।

परीक्षण और सत्यापन

डेटा प्रारूप सत्यापित करना

ऐप स्वचालित रूप से प्रत्येक अनुरोध में इन हेडर को शामिल करता है:

• Content-Type - निर्यात प्रारूप के आधार पर सेट
• automation-name - आपके ऑटोमेशन का नाम
• automation-id - ऑटोमेशन के लिए अद्वितीय पहचानकर्ता
• automation-aggregation - चयनित समय समूहीकरण
• automation-period - चयनित तिथि सीमा
• session-id - प्रत्येक अनुरोध के लिए अद्वितीय पहचानकर्ता

समस्या निवारण

सामान्य समस्याएं

एंडपॉइंट पर डेटा प्राप्त नहीं हुआ

• सत्यापित करें कि एंडपॉइंट URL सही है
• जांचें कि आपका एंडपॉइंट POST अनुरोध स्वीकार करता है
• प्रमाणीकरण हेडर की समीक्षा करें
• आने वाले अनुरोधों के लिए एंडपॉइंट लॉग की जांच करें
• नेटवर्क कनेक्टिविटी सत्यापित करें

सुझाव और सर्वोत्तम अभ्यास

1. स्वचालित सिंक:

   • डिवाइस चार्ज करें और iPhone मिररिंग का उपयोग करें
     • चार्ज करते समय iOS प्रदर्शन पर कम प्रतिबंध लगाता है, इसलिए डेटा अधिक बार सिंक हो सकता है
     • iPhone मिररिंग से डिवाइस अनलॉक जैसा व्यवहार करता है। इससे Health Auto Export स्वास्थ्य डेटा तक पहुँचकर स्वचालित कार्रवाइयाँ चला सकता है

2. प्रदर्शन:

   • विस्तार बनाम डेटा आकार को संतुलित करने के लिए उपयुक्त समय समूहीकरण का उपयोग करें
   • केवल आवश्यक मेट्रिक्स चुनें

3. विश्वसनीयता:

   • अपने एंडपॉइंट की प्रतिक्रिया समय के आधार पर उपयुक्त टाइमआउट मान सेट करें
   • गतिविधि लॉग को नियमित रूप से मॉनिटर करें

4. डेटा प्रारूप:

   • संरचित डेटा और API के लिए JSON का उपयोग करें
   • सरल डेटा विश्लेषण या स्प्रेडशीट एकीकरण के लिए CSV का उपयोग करें
   • बड़े डेटासेट या अलग प्रसंस्करण के लिए बैच अनुरोध पर विचार करें

गतिविधि लॉग देखना

1. ऑटोमेशन कॉन्फ़िगरेशन स्क्रीन में गतिविधि लॉग देखें पर टैप करें।
2. रन की समीक्षा करें (समूहीकृत, नवीनतम पहले) और प्रत्येक रन के भीतर इवेंट विस्तृत करें।
3. चेतावनियाँ (उदा., धीमा स्वास्थ्य डेटा क्वेरी) को त्रुटियाँ (HTTP विफलताएँ, टाइमआउट या HealthKit पढ़ने की विफलताएँ) से अलग करें—ऑटोमेशन अवलोकन — गतिविधि लॉग देखें।
4. सफल REST अपलोड में अक्सर रन में प्रारूप, डेटा प्रकार, निर्यात अवधि और तिथि सीमा के साथ सारांश दिखता है।
5. साझा करें (टूलबार) सहायता के लिए पूर्ण ऐप इवेंट लॉग डायग्नोस्टिक ZIP निर्यात करता है (सेटिंग्स → उन्नत के समान)।
6. साफ़ करें केवल इस ऑटोमेशन का गतिविधि इतिहास हटाता है।