विषय पर बढ़ें

किसी ऐप की कोई भी API कॉल करें

जिस एंडपॉइंट का कोई तैयार एक्शन नहीं है, उसे अपने सेव किए हुए अकाउंट से Custom API call के ज़रिए कॉल करें।

शुरू करने से पहले

  • आप Super Admin या System Admin हों। बाकी रोल को Custom API call नहीं दिखता।
  • ऐप कनेक्ट हो। देखें फ़्लो में ऐप का स्टेप जोड़ें।
  • आपको ऐप के API दस्तावेज़ों से एंडपॉइंट पता हो: उसका मेथड, पाथ और फ़ील्ड।

कस्टम कॉल कैसे काम करती है

  • स्टेप ऐप की अपनी API पर एक रिक्वेस्ट भेजता है, आपके तय किए मेथड, पाथ और डेटा के साथ।
  • Ohanvi रिक्वेस्ट पर 1 · Account वाले अकाउंट से साइन करता है। आपको कभी टोकन पेस्ट नहीं करना पड़ता।
  • पाथ ऐप के अपने पते के साथ जुड़ता है। कस्टम कॉल किसी दूसरी वेबसाइट तक नहीं पहुँच सकती।
  • यह सिर्फ़ कुछ ऐप में मिलता है। जो ऐप अपनी स्क्रीन पर कनेक्ट होते हैं, जैसे Shopify और Shiprocket, उनमें नहीं।
  • कस्टम कॉल कभी दोबारा नहीं चलाई जाती, क्योंकि वह डेटा बना या बदल सकती है।

स्टेप

  1. फ़्लो को बिल्डर में खोलें। किसी स्टेप के बाद + पर क्लिक करें। Add a step after पैनल खुलता है।
  2. Apps के नीचे ऐप पर क्लिक करें।
  3. Advanced के नीचे Custom API call पर क्लिक करें।
  4. 1 · Account के नीचे अकाउंट चुनें।
  5. 2 · What to send के नीचे Method देखें। यह GET से शुरू होता है। ज़रूरत हो, तो इसे POST, PUT, PATCH या DELETE करें।
  6. Path में एंडपॉइंट का पाथ लिखें, जैसे /v1/orders। ऐप का पता न लिखें।

    [SCREENSHOT: Custom API call स्टेप, जिसमें Method, Path और ऐप के अपने पते वाला नोट दिख रहा हो]

  7. वैकल्पिक फ़ील्ड देखने के लिए +3 more fields पर क्लिक करें:

    • Query parameters: एक JSON ऑब्जेक्ट, जैसे { "limit": 10 }।
    • Headers: अतिरिक्त हेडर का JSON ऑब्जेक्ट। साइन-इन वाले हेडर अपने आप जुड़ जाते हैं।
    • Body: POST, PUT या PATCH के साथ भेजा जाने वाला JSON।
  8. फ़ॉर्म के नीचे का नोट पढ़ें, जैसे Signed with this account. The path stays on Canva's own address.
  9. कॉल जाँचने के लिए 3 · Test के नीचे Test this step पर क्लिक करें। फिर Save और Publish पर क्लिक करें।

किसी भी फ़ील्ड में पिछले स्टेप की वैल्यू इस्तेमाल की जा सकती है, जैसे { "email": "{{trigger.email}}" }।

कस्टम कॉल असली काम करती है

POST, PUT, PATCH या DELETE ऐप का डेटा बदलते हैं, टेस्ट में भी। टेस्ट करने से पहले पाथ और बॉडी जाँच लें।

समस्या का समाधान

समस्या कारण समाधान
लिस्ट में Custom API call नहीं है आपका रोल एडमिन नहीं है, या ऐप में यह विकल्प नहीं है। किसी Super Admin से स्टेप जुड़वाएँ। नहीं तो ऐप के तैयार एक्शन इस्तेमाल करें।
Only an admin (Super Admin or System Admin) can publish a Custom API call step. फ़्लो में कस्टम कॉल है और आप एडमिन नहीं हैं। किसी एडमिन से फ़्लो पब्लिश करवाएँ।
'path' must be relative to the app's base URL, not a full address. Path https:// से शुरू होता है। सिर्फ़ पते के बाद वाला हिस्सा लिखें, जैसे /v1/orders।
Put query parameters in 'query', not in 'path'. Path में ? है। पैरामीटर Query parameters में ले जाएँ।
'headers' cannot set … कोई हेडर साइन-इन या रूटिंग की जानकारी सेट करने की कोशिश करता है। वह हेडर हटाएँ। सेव किया हुआ अकाउंट रिक्वेस्ट पर साइन करता है।
A custom call can only reach …, the app's own API. पाथ ऐप के पते से बाहर ले जाता है। ऐप की अपनी API का पाथ इस्तेमाल करें।