एपीआई Mewayz ऐड-ऑन
निर्बाध परियोजना और कार्य प्रबंधन के लिए Mewayz के एपीआई एकीकरण की शक्ति की खोज करें। आसानी से विस्तार करें और अनुकूलित करें। अब कोशिश करो!
परिचय
एपीआई डॉक्स जेनरेटर एक शक्तिशाली ऐड-ऑन है जो Mewayz प्लेटफॉर्म के लिए संपूर्ण एपीआई दस्तावेज़ीकरण प्रदान करता है। यह ऐड-ऑन डेवलपर्स और तकनीकी टीमों को एंडपॉइंट, हेडर, पैरामीटर और प्रतिक्रिया उदाहरण सहित विस्तृत एपीआई जानकारी तक पहुंचने में मदद करता है। दस्तावेज़ीकरण प्लेटफ़ॉर्म के 14 प्रमुख मॉड्यूल को कवर करता है और उपयोगकर्ताओं को पोस्टमैन जैसे टूल का उपयोग करके कस्टम एप्लिकेशन बनाने, बाहरी सिस्टम को एकीकृत करने या मैन्युअल रूप से एपीआई का परीक्षण करने में सक्षम बनाता है।
इस मॉड्यूल को कैसे सक्षम करें
एपीआई ऐड-ऑन सेट अप करने के लिए, आप इस लिंक का अनुसरण कर सकते हैं: सेटअप ऐड-ऑन.
एपीआई ऐड-ऑन का उपयोग कैसे करें?
एपीआई डॉक्स जनरेट करें
इस ऐड-ऑन को खरीदने और इंस्टॉल करने के बाद, अपने डैशबोर्ड साइडबार पर जाएं और एपीआई डॉक्स ऐड-ऑन खोजें।
एपीआई दस्तावेज़ तक पहुंचने के लिए, अपने मुख्य डैशबोर्ड से एपीआई डॉक्स अनुभाग पर जाएँ। दस्तावेज़ीकरण का आयोजन किया जाता है 14 मॉड्यूल, जिससे आपके एकीकरण प्रोजेक्ट के लिए आवश्यक विशिष्ट एपीआई ढूंढना आसान हो जाता है।
अनुभाग में एक सामान्य परिचय शामिल है जो बताता है कि एपीआई का प्रभावी ढंग से उपयोग कैसे करें। यह अवलोकन प्रमाणीकरण आवश्यकताओं, सामान्य हेडर और बुनियादी उपयोग दिशानिर्देशों को शामिल करता है जो सभी एपीआई एंडपॉइंट पर लागू होते हैं।
प्रत्येक मॉड्यूल में संपूर्ण तकनीकी विवरण के साथ शक्तिशाली एपीआई लिस्टिंग होती है। प्रत्येक एपीआई एंडपॉइंट के लिए, आपको एपीआई नाम, सटीक एंडपॉइंट यूआरएल, प्रमाणीकरण और डेटा प्रारूप के लिए आवश्यक हेडर, उनके डेटा प्रकार और सत्यापन नियमों के साथ इनपुट पैरामीटर, अपेक्षित डेटा संरचना दिखाने वाली सफलता प्रतिक्रियाएं, और सामान्य त्रुटि कोड और संदेशों के साथ उदाहरण त्रुटि प्रतिक्रियाएं मिलेंगी।
परिचय प्रबंधन
यह व्यापक एपीआई दस्तावेज़ Mewayz की विशेषताओं की शक्ति का उपयोग करने के लिए आपका प्रवेश द्वार है, जो आपको अपने काम को सुव्यवस्थित करने, उत्पादकता बढ़ाने और अपनी परियोजनाओं को अगले स्तर पर लाने की अनुमति देता है।
यह एपीआई दस्तावेज़ अनुभवी और नए दोनों डेवलपर्स के लिए एक संसाधन है, जो अपने अनुप्रयोगों के भीतर Mewayz की क्षमताओं का लाभ उठाना चाहते हैं। यहां वह है जो आप पाने की उम्मीद कर सकते हैं।
आप नीचे उत्पाद के अंदर पूर्ण, इंटरैक्टिव संदर्भ ब्राउज़ कर सकते हैं सेटिंग्स → एपीआई दस्तावेज़.
एंडपॉइंट अनुभाग में डेटा पुनर्प्राप्त करने के लिए GET, नया डेटा बनाने के लिए POST, मौजूदा डेटा को अपडेट करने के लिए POST और डेटा हटाने के लिए DELETE शामिल है। आप डेटा पुनर्प्राप्त करने के लिए GET, नया डेटा बनाने के लिए POST, मौजूदा डेटा को अपडेट करने के लिए POST और डेटा हटाने के लिए DELETE जैसी HTTP विधियों का उपयोग कर सकते हैं।
अनुरोध पैरामीटर का उपयोग आपके एपीआई अनुरोधों के व्यवहार को अनुकूलित करने और एपीआई के साथ बातचीत करते समय अधिक विशिष्ट विवरण प्रदान करने के लिए किया जाता है। Mewayz के लिए, आपके पास निम्न प्रकार के अनुरोध पैरामीटर हो सकते हैं: जानकारी पुनर्प्राप्त करते समय डेटा को फ़िल्टर या सॉर्ट करने के लिए क्वेरी पैरामीटर, प्रमाणीकरण के लिए अनुरोध हेडर और अनुरोध के बारे में अतिरिक्त मेटाडेटा, और अनुरोध बॉडी जिसमें JSON डेटा बनाया या अपडेट किया जाना है।
Mewayz का एपीआई आमतौर पर JSON प्रारूप में डेटा के साथ प्रतिक्रिया करता है। प्रतिक्रिया में आम तौर पर एक HTTP स्थिति कोड शामिल होता है जो अनुरोध के परिणाम को दर्शाता है, और वास्तविक डेटा इसके भीतर निहित होता है "डेटा" फ़ील्ड.
प्रमाणीकरण प्रबंधन
प्रमाणीकरण एपीआई आवश्यक लॉगिन कार्यक्षमता, सत्र बनाए रखने के लिए टोकन रीफ्रेश क्षमताएं और उपयोगकर्ता सत्र को सुरक्षित रूप से समाप्त करने के लिए लॉगआउट प्रक्रियाएं प्रदान करते हैं।
लॉगिन एंडपॉइंट POST /api/login के लिए हेडर की आवश्यकता होती है "स्वीकार करें": "एप्लिकेशन/जेएसओएन" और ईमेल जैसे पैरामीटर “[email protected]” और पासवर्ड जैसे **"जॉन****"**।
त्रुटि प्रतिक्रियाएँ 422 असंसाधित सामग्री लौटाती हैं "सफलता": झूठा, "संदेश": “सत्यापन जब सत्यापन एक त्रुटि है।
त्रुटि प्रतिक्रियाएँ 400 अनधिकृत के साथ लौटती हैं "सफलता": झूठा, "संदेश": "प्रदान किया गया" जब क्रेडेंशियल अमान्य हों.
सफल लॉगिन प्रतिक्रियाएँ 200 ओके के साथ वापस आती हैं "सफलता": सत्य और प्राधिकरण जिसमें टोकन और प्रकार शामिल है "वाहक" बाद की एपीआई कॉल के लिए।
ऑथ रिफ्रेश एंडपॉइंट POST /api/refresh सत्र प्रबंधन के लिए बियरर टोकन के साथ प्राधिकरण हेडर का उपयोग करता है।
सफल रिफ्रेश प्रतिक्रियाएं 200 ओके सहित विस्तृत उपयोगकर्ता जानकारी लौटाती हैं "सफलता": सत्य, और उपयोगकर्ता विवरण, आईडी, नाम, ईमेल, मोबाइल नंबर, प्रकार : "कंपनी", अवतार: "यूआरएल", लैंग: "एन" और टोकन.
उपयोगकर्ता प्रबंधन
- उपयोगकर्ता प्रशासन, भूमिका प्रबंधन और प्रोफ़ाइल के लिए उपयोगकर्ता एपीआई
परिचालन.
गोदाम प्रबंधन
- वेयरहाउस कॉन्फ़िगरेशन और वेयरहाउस स्थानांतरण के लिए वेयरहाउस एपीआई
प्रबंधन.
उत्पाद एवं सेवा प्रबंधन
- उत्पाद और सेवा अनुभाग एपीआई उत्पाद श्रेणियों, करों का प्रबंधन करते हैं,
गोदाम एकीकरण के साथ माप इकाइयाँ, उत्पाद और स्टॉक प्रबंधन।
खरीद चालान प्रबंधन
- खरीद चालान सूची के लिए खरीद चालान एपीआई, बनाएं, विवरण,
अद्यतन करें, हटाएँ, चालान पोस्ट प्रबंधन।
खरीद वापसी प्रबंधन
- खरीद वापसी सूची, निर्माण, वापसी विवरण को संभालने के लिए एपीआई
हटाएँ, स्वीकृत करें, प्रसंस्करण पूर्ण करें।
बिक्री प्रस्ताव प्रबंधन
- प्रस्ताव प्रबंधन और रूपांतरण के लिए बिक्री प्रस्ताव एपीआई
प्रक्रियाएँ।
बिक्री चालान प्रबंधन
- बिक्री चालान एपीआई चालान सूची, निर्माण, अद्यतन, हटाएं, संभालते हैं
चालान पोस्ट प्रबंधन.
बिक्री चालान वापसी प्रबंधन
- बिक्री चालान रिटर्न सूची के प्रबंधन के लिए एपीआई, बनाएं, विवरण दें, हटाएं,
स्वीकृत करें और पूर्ण करें.
खाता प्रबंधन
- खाता अनुभाग एपीआई आपको ग्राहकों, विक्रेताओं को प्रबंधित करने की अनुमति देता है।
- खाता मॉड्यूल में सरल पुनर्प्राप्ति के लिए त्वरित सूची एपीआई शामिल हैं
बैंक खाते, खातों का चार्ट, राजस्व, व्यय, क्रेडिट नोट, डेबिट नोट, विक्रेता भुगतान, ग्राहक भुगतान, बैंक लेनदेन, बैंक हस्तांतरण रिकॉर्ड। आप रिकॉर्ड को सूचीबद्ध करना, नई प्रविष्टियाँ बनाना, विवरण देखना, जानकारी अपडेट करना और आवश्यकतानुसार रिकॉर्ड हटाने जैसे कार्य कर सकते हैं।
ग्राहक और विक्रेता सूचियाँ, जीएल खाता सूची, ड्रॉपडाउन चयन और त्वरित संदर्भ के लिए राजस्व और व्यय श्रेणियों के साथ।
परियोजना प्रबंधन
- परियोजना अनुभाग एपीआई परियोजनाओं, कार्यों, बग, मील के पत्थर, का प्रबंधन करते हैं
फ़ाइलें, और विभिन्न रिपोर्टें उनके संबंधित चरणों और वर्कफ़्लो के साथ।
पीओएस प्रबंधन
- पीओएस एपीआई ऑर्डर प्रबंधन सहित पॉइंट-ऑफ-सेल संचालन को संभालते हैं
और ऑर्डर विवरण।
सीआरएम प्रबंधन
- सीआरएम अनुभाग एपीआई पाइपलाइन प्रबंधन, लीड और डील चरणों को कवर करते हैं,
लेबल, स्रोत, और संपूर्ण लीड प्रबंधन, और डील प्रबंधन। आप लीड और डील दोनों से जुड़े कार्यों, उपयोगकर्ताओं, उत्पादों, स्रोतों, ईमेल, चर्चाओं, फ़ाइलों और कॉलों को प्रबंधित कर सकते हैं।
एचआरएम प्रबंधन
- एचआरएम एपीआई कर्मचारी प्रबंधन, संगठनात्मक संरचना को संभालते हैं,
उपस्थिति ट्रैकिंग, छुट्टी प्रबंधन, पेरोल प्रसंस्करण, और पुरस्कार, पदोन्नति, इस्तीफे, समाप्ति, चेतावनियां, शिकायतें, कर्मचारी स्थानांतरण, छुट्टियां, घटनाएं, दस्तावेज, घोषणाएं और स्वीकृतियां सहित विभिन्न एचआर रिकॉर्ड।
दस्तावेज़ीकरण में प्रत्येक एपीआई एंडपॉइंट में व्यावहारिक उदाहरण शामिल हैं जिन्हें आप कॉपी कर सकते हैं और सीधे अपने विकास वातावरण या परीक्षण टूल में उपयोग कर सकते हैं। प्रतिक्रिया उदाहरण सफल संचालन और सामान्य त्रुटि परिदृश्य दोनों दिखाते हैं, जिससे आपको अपने अनुप्रयोगों में उचित त्रुटि प्रबंधन लागू करने में मदद मिलती है।
मॉड्यूल वार एपीआई सूची:
- प्रमाणीकरण :
- लॉग इन करें
- टोकन ताज़ा करें
- लॉगआउट करें
- उपयोगकर्ता:
- उपयोगकर्ता: सूची बनाएं, बनाएं, अपडेट करें, हटाएं,
- भूमिका : सूची
- उपयोगकर्ता लॉग: सूची
- स्टाफ उपयोगकर्ता: सूची
- ग्राहक उपयोगकर्ता: सूची
- विक्रेता उपयोगकर्ता: सूची
- गोदाम :
प्रोफ़ाइल अपडेट, पासवर्ड अपडेट, पासवर्ड रीसेट करें, सत्यापित करें
- गोदाम : सूची बनाएं, बनाएं, विवरण दें, अद्यतन करें,
- स्थानांतरण : सूची बनाएं, अनुरोध डेटा बनाएं,
- उत्पाद एवं सेवा :
हटाएँ
बनाएं, हटाएं
- उत्पाद श्रेणी: सूची बनाएं, बनाएं, अद्यतन करें,
- कर : सूची बनाएं, बनाएं, अपडेट करें, हटाएं
- इकाई : सूची बनाएं, बनाएं, अपडेट करें, हटाएं
- उत्पाद: सूची बनाएं, बनाएं, विवरण दें, अद्यतन करें,
- उत्पाद स्टॉक: सूची, जोड़ें
- गोदाम उत्पाद: सूची
- खरीद चालान:
हटाएँ
हटाएँ
- चालान: सूची बनाएं, बनाएं, विवरण दें, अद्यतन करें,
- खरीद वापसी :
हटाएं, पोस्ट करें
- वापसी : सूची बनाएं, बनाएं, विवरण दें, हटाएं,
- बिक्री प्रस्ताव:
स्वीकृत, पूर्ण
- प्रस्ताव : सूची बनाएं, बनाएं, विवरण दें, अद्यतन करें,
- बिक्री चालान:
हटाएं, भेजें, स्वीकार करें, अस्वीकार करें, चालान में बदलें
- चालान: सूची बनाएं, बनाएं, विवरण दें, अद्यतन करें,
- बिक्री चालान रिटर्न:
हटाएं, पोस्ट करें
- वापसी : सूची बनाएं, बनाएं, विवरण दें, हटाएं,
- खाता :
स्वीकृत, पूर्ण
- ग्राहक प्राप्त करें: सरल ग्राहक सूची
- विक्रेता प्राप्त करें: सरल विक्रेता सूची
- ग्राहक: सूची बनाएं, बनाएं, अपडेट करें, हटाएं
- विक्रेता: सूची बनाएं, बनाएं, अपडेट करें, हटाएं
- जीएल खाता: सूची
- बैंक खाता : सूची बनाएं, बनाएं, अपडेट करें, हटाएं
- राजस्व श्रेणियाँ : सूची
- राजस्व : सूची बनाएं, बनाएं, अपडेट करें, हटाएं,
- व्यय श्रेणियाँ : सूची
- व्यय : सूची बनाएं, बनाएं, अपडेट करें, हटाएं,
- खाता प्रकार : सूची
- खाते का चार्ट: सूची
- बैंक लेनदेन : सूची
- बैंक स्थानांतरण : सूची
- विक्रेता भुगतान: सूची
- ग्राहक भुगतान: सूची
- क्रेडिट नोट: सूची
- डेबिट नोट: सूची
- परियोजना :
स्वीकृत करें, पोस्ट करें
स्वीकृत करें, पोस्ट करें
- परियोजना : सूची बनाएं, बनाएं, विवरण दें, अद्यतन करें,
- परियोजना सदस्य: हटाएँ
- प्रोजेक्ट क्लाइंट: सूची बनाएं, आमंत्रित करें, हटाएं
- परियोजना मील का पत्थर: सूची बनाएं, बनाएं, अद्यतन करें,
- प्रोजेक्ट फ़ाइल: बनाएं, हटाएं
- कार्य : टास्क बोर्ड, बनाएं, विवरण, अद्यतन करें,
- कार्य टिप्पणी : बनाएं, हटाएं
- कार्य उपकार्य : बनाएं, अद्यतन करें
- बग स्थिति: सूची
- बग : सूची बनाएं, बनाएं, विवरण दें, अपडेट करें, हटाएं
- बग टिप्पणी : बनाएं, हटाएं
- परियोजना रिपोर्ट: सूची, विवरण
- कार्य चरण : सूची, ऑर्डर, बनाएं, अपडेट करें,
- बग स्टेज: सूची, ऑर्डर, बनाएं, अपडेट करें,
- पीओएस:
हटाएँ
हटाएँ
हटाएँ
हटाएँ
हटाएँ
- आदेश : सूची, विवरण
- सीआरएम:
- पाइपलाइन : सूची बनाएं, बनाएं, अपडेट करें, हटाएं
- लीड स्टेज: सूची बनाएं, बनाएं, अपडेट करें, हटाएं
- डील स्टेज: सूची बनाएं, बनाएं, अपडेट करें, हटाएं
- लेबल : सूची बनाएं, बनाएं, अपडेट करें, हटाएं
- स्रोत: सूची बनाएं, बनाएं, अपडेट करें, हटाएं
- लीड : सूची बनाएं, बनाएं, विवरण दें, अद्यतन करें,
- नेतृत्व कार्य : बनाएं, अपडेट करें, हटाएं
- लीड उपयोगकर्ता : बनाएं, हटाएं
- मुख्य उत्पाद: बनाएं, हटाएं
- लीड स्रोत: बनाएं, हटाएं
- लीड ईमेल : बनाएँ
- मुख्य चर्चा : बनाएँ
- लीड फ़ाइल: बनाएं, हटाएं
- लीड कॉल: बनाएं, अपडेट करें, हटाएं
- डील : सूची बनाएं, बनाएं, विवरण दें, अद्यतन करें,
- डील कार्य : बनाएं, अपडेट करें, हटाएं
- डील उपयोगकर्ता: बनाएं, हटाएं
- डील उत्पाद: बनाएं, हटाएं
- डील स्रोत: बनाएं, हटाएं
- डील ईमेल: बनाएँ
- डील चर्चा: बनाएँ
- डील फ़ाइल: बनाएं, हटाएं
- डील ग्राहक: बनाएं, हटाएं
- डील कॉल: बनाएं, अपडेट करें, हटाएं
- मानव संसाधन विकास मंत्री :
हटाएं, लेबल जोड़ें, डील में कनवर्ट करें
हटाएं, लेबल जोड़ें
- कर्मचारी : सूची बनाएं, बनाएं, विवरण दें, अद्यतन करें,
- उपस्थिति : सूची बनाएं, बनाएं, अपडेट करें, हटाएं
- छुट्टी के प्रकार : सूची
- आवेदन छोड़ें : सूची बनाएं, बनाएं, अद्यतन करें,
- अवकाश शेष : जांचें
- पेरोल : सूची, विवरण
- वेतन पर्ची : उत्पन्न करें
- बदलाव: सूची
- शाखाएँ: सूची
- विभाग : सूची
- पदनाम : सूची
- दस्तावेज़ प्रकार: सूची
- छुट्टियाँ : सूची
- पुरस्कार : सूची
- प्रचार : सूची
- इस्तीफ़ा : सूची
- समाप्ति : सूची
- चेतावनियाँ : सूची
- शिकायतें : सूची
- कर्मचारी स्थानांतरण : सूची
- दस्तावेज़: सूची
- आभार: सूची
- घोषणाएँ: सूची
- घटनाएँ : सूची
हटाएँ
हटाएं, स्थिति अपडेट करें