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

एक कुंजी। हर मॉड्यूल।

अधिकांश व्यावसायिक सॉफ़्टवेयर आपको प्रति उत्पाद एक API देते हैं — एक बिल के लिए, दूसरा स्टॉक के लिए, तीसरा चालान के लिए, प्रत्येक अपनी प्रमाणीकरण और अपनी तारीख की अवधारणा के साथ। Kardopal के पास एक है। वही कुंजी, वही बेस URL और वही क्वेरी व्याकरण 29 मॉड्यूल में 129 संसाधनों तक पहुँचते हैं।

API कुंजी बनाएं देखें यह कहाँ तक पहुँचता है
29
मॉड्यूल
129
संसाधन
1
कुंजी, एक बेस URL
200
प्रति पृष्ठ पंक्तियाँ, अधिकतम।

यह API जिस पर निर्माण करना सार्थक है

छह बातें जो यहाँ सच हैं और आमतौर पर नहीं होतीं।

यह स्वयं का वर्णन करता है

बेस URL पर हिट करें और API अपना कैटलॉग वापस देता है — हर वह मॉड्यूल जिसे आपकी कुंजी देख सकती है, उसके अंदर हर संसाधन, कौन से फ़ील्ड खोजे जा सकते हैं और कौन से फ़िल्टर किए जा सकते हैं। आपको इंटीग्रेशन लिखने के लिए इस पेज की आवश्यकता नहीं है; आपको यह तय करने के लिए इसकी आवश्यकता है।

सही मायने में पहुँच नियंत्रित करने वाली अनुमतियाँ

ऐप में स्कोप, रूट और परमिशन पिल्स एक सूची से जनरेट होते हैं, इसलिए कोई परमिशन तब तक नहीं दी जा सकती जब तक उसके पीछे कोई एंडपॉइंट न हो। एक कुंजी जो स्कोप की गई है आइटम आइटम प्राप्त करता है — इसे पेरोल के लिए पूछने पर 403 आता है, न कि एक खाली पेज।

एक क्वेरी व्याकरण, हर जगह

खोजें, से, तक, छोड़ें और लेना इनवॉइस पर उनका वही मतलब होता है जो स्टॉक मूवमेंट पर होता है। एक बार आकार सीखें और 133 संसाधनों में से हर एक उसका जवाब देता है।

आपका किरायेदार, और केवल आपका

हर टेबल में एक टेनेंट आईडी होती है और हर क्वेरी डेटाबेस तक पहुँचने से पहले कुंजी के अपने टेनेंट तक सीमित होती है। कोई क्रॉस-टेनेंट रीड गलत होने की संभावना नहीं है, क्योंकि ऐसा कोई पैरामीटर नहीं है जो इसकी मांग कर सके।

फ़ील्ड अपनी सत्यता बनाए रखते हैं

फ़ील्ड सूची बूट के समय लाइव स्कीमा से पढ़ी जाती है, हाथ से नहीं बनाई जाती। एक नया कॉलम अपने आप दिखाई देता है; हटाए गए कॉलम से डॉक्स में कभी कोई अधूरा संदर्भ या पहली कॉल पर 500 त्रुटि नहीं आती।

केवल पढ़ने के लिए, जानबूझकर

कुंजियाँ पढ़ती हैं; वे कभी लिखती नहीं हैं। एक गलत इंटीग्रेशन किसी इनवॉइस को रद्द नहीं कर सकता या स्टॉक को स्थानांतरित नहीं कर सकता। रिकॉर्ड में कोई भी बदलाव ऐप या स्टाफ लॉगिन के माध्यम से होता है, जहाँ इसे एक व्यक्ति को सौंपा जाता है और ऑडिट लॉग में दर्ज होता है।

एक अनुरोध में शुरू करें

सब कुछ एक GET है। यदि आप उपयोग कर सकते हैं curl, आप इसका उपयोग कर सकते हैं।

GET /api/v1आपकी कुंजी जिस पूरे कैटलॉग को देख सकती है
curl https://api.kardopal.com/api/v1 \
  -H "X-API-Key: kp_live_…"
GET /api/v1/meसुरक्षा जांच — यह किसकी कुंजी है, और यह क्या पढ़ सकती है
{
  "authType": "api_key",
  "tenant": { "name": "Nova Retail", "plan": "pro" },
  "scopes": ["items", "sales", "pos"]
}
GET /api/v1/items?search=lamp&take=2कोई भी संसाधन, एक ही रूप
{
  "resource": "items",
  "scope": "items",
  "total": 41,
  "skip": 0,
  "take": 2,
  "hasMore": true,
  "data": [ { "id": "…", "name": "Desk Lamp LED" } ]
}
GET /api/v1/meta/countsप्रति संसाधन पंक्ति गणना — देखें कि वास्तव में कौन सा डेटा मौजूद है
curl https://api.kardopal.com/api/v1/meta/counts \
  -H "X-API-Key: kp_live_…"

पाँच पैरामीटर

पैरामीटरकरता हैनोट्स
खोजेंसंसाधन के खोज योग्य फ़ील्ड में केस-संवेदी मिलान।वे कौन से फ़ील्ड हैं, इसकी सूची इसमें दी गई है /meta
सेकेवल इस तिथि से आगे के रिकॉर्डउस फ़ील्ड पर लागू होता है जिसके द्वारा संसाधन सॉर्ट होता है
तककेवल इस तारीख तक के रिकॉर्डइसके साथ मिलाएं से एक विंडो के लिए
छोड़ेंपरिणाम सेट में ऑफसेटडिफ़ॉल्ट 0 है
लेनाकितनी पंक्तियाँ लौटानी हैंडिफ़ॉल्ट 50, अधिकतम 200

संसाधन अपने घोषित फ़ील्ड पर सटीक-मिलान फ़िल्टर भी स्वीकार करते हैं — ?status=paid, ?warehouseId=… — और हर एक विज्ञापन करता है कि वे कौन से हैं। हर सूची प्रतिक्रिया में होता है कुल और और भी है, ताकि पेजिंग एक लूप हो, अनुमान नहीं।

API की पहुँच

29 मॉड्यूल, 129 संसाधन। प्रत्येक कार्ड एक अनुमति है जिसे आप एक कुंजी को दे सकते हैं — और ग्रे टैग वह जगह है जहां आपके फोन पर ऐप में वही रिकॉर्ड रहते हैं।

संपर्क

2

ग्राहक, आपूर्तिकर्ता और वे जिन खंडों में आते हैं।

संपर्कसंपर्क-सेगमेंट
संपर्क संपर्क

आइटम

7

कैटलॉग: उत्पाद, प्रकार, ब्रांड, मूल्य सूची और इकाइयाँ।

आइटमश्रेणियांब्रांडआइटम-वेरिएंटमूल्य-सूचियाँइकाइयाँ+1 और
आइटम आइटम

इन्वेंट्री

7

गोदाम, स्टॉक स्तर, आवाजाही, बैच, सीरियल और डिब्बे।

गोदामstock-movementsस्टॉक-स्तरबैचserialsस्टॉक-गणना+1 और
इन्वेंट्री इन्वेंट्री

बिक्री

7

इनवॉइस, अनुमान, ऑर्डर, क्रेडिट नोट और भुगतान।

चालानअनुमानबिक्री-ऑर्डरक्रेडिट-नोटभुगतानआवर्ती-इनवॉइस+1 और
बिक्री बिक्री

POS

11

टिल, शिफ्ट, रसीदें, टेबल और हर बिक्री जो काउंटर से गुजरी।

पीओएस-बिक्रीPOS-शिफ्टPOS-टर्मिनलPOS उपयोगकर्ताPOS टेबलपीओएस-टेबल-क्षेत्र+5 और
pos POS

CRM

4

लीड, डील, पाइपलाइन और प्रस्ताव।

लीड्ससौदेपाइपलाइनप्रस्ताव
crm CRM

खरीद

5

खरीद आदेश, अनुरोध, रिटर्न, बिल और विक्रेता भुगतान।

खरीद-आदेशखरीद-अनुरोधखरीद वापसीबिलविक्रेता भुगतान
खरीद खरीद

अकाउंटिंग

5

खर्च, बैंक खाते, लेनदेन और कर दरें।

खर्चखर्च-श्रेणियाँबैंक-खातेbank-transactionsकर-दरें
अकाउंटिंग अकाउंटिंग

मार्केटिंग

4

अभियान, प्राप्तकर्ता, लैंडिंग पेज और फ़ॉर्म सबमिशन।

अभियानcampaign-recipientsलैंडिंग-पेजफॉर्म सबमिशन
मार्केटिंग मार्केटिंग

HR

8

कर्मचारी, विभाग, छुट्टी, वेतन पर्ची, उपस्थिति और भर्ती।

कर्मचारीविभागleave-requestsवेतन पर्चीउपस्थितिनौकरी-पोस्टिंग+2 और
hr HR

टाइमशीट

2

समय प्रविष्टियाँ और उनसे संबंधित परियोजनाएँ।

समय-प्रविष्टियाँटाइमशीट-प्रोजेक्ट
टाइमशीट टाइमशीट

प्रोजेक्ट

3

परियोजनाएं, चरण और उनसे जुड़ी लागतें।

परियोजनाएँproject-phasesपरियोजना लागत
परियोजनाएँ प्रोजेक्ट

बुकिंग

3

नियुक्तियाँ, बुक करने योग्य सेवाएँ और उन्हें प्रदान करने वाले कर्मचारी।

बुकिंगबुकिंग-सेवाएंबुकिंग-स्टाफ
बुकिंग बुकिंग

फील्ड सर्विस

7

जॉब, तकनीशियन, वर्क ऑर्डर, अनुबंध और उपकरण।

फील्ड-जॉब्सतकनीशियनservice-requestsसेवा अनुबंधकार्य-आदेशजॉब-कार्ड्स+1 और
फील्ड_सर्विस फील्ड सर्विस

लॉजिस्टिक्स।

5

शिपमेंट, ड्राइवर, वाहन, ज़ोन और वाहक।

शिपमेंटड्राइवरवाहनडिलीवरी ज़ोनकैरियर
लॉजिस्टिक्स लॉजिस्टिक्स।

हेल्पडेस्क

5

टिकट, SLA नीतियां, सहायता लेख और नॉलेज बेस।

टिकटग्राहक-टिकटसहायता-लेखनॉलेज-बेसSLA-नीतियाँ
सपोर्ट हेल्पडेस्क

बिक्री के बाद

5

रिटर्न, वारंटी क्लेम, मरम्मत और उत्पाद पंजीकरण।

RMAवारंटी-दावेवारंटी-पंजीकरणमरम्मतउत्पाद-पंजीकरण
बिक्री के बाद बिक्री के बाद

किराया

3

किराए पर लेने योग्य संपत्तियां, किराये के समझौते और उनकी लाइनें।

संपत्तिकिराए पर देनाकिराये की लाइनें
किराया किराया

रेस्टोरेंट

2

मेनू और उसके विरुद्ध दिए गए ऑर्डर।

मेनू-आइटममेनू-ऑर्डर
रेस्टोरेंट F&B

कतार

5

टिकट, सेवाएं, काउंटर, शाखाएं और डिस्प्ले स्क्रीन।

कतार-टिकटकतार सेवाएंकतार-काउंटरकतार शाखाएँकतार-डिस्प्ले
कतार कतार

लॉयल्टी

6

सदस्य, खाते, टियर, रिवॉर्ड और पॉइंट लेनदेन।

loyalty-membersलॉयल्टी खातेलॉयल्टी रिवॉर्ड्सलॉयल्टी-टियरलॉयल्टी ट्रांजैक्शनloyalty-coupons
लॉयल्टी लॉयल्टी

स्थान

2

साइटें और शाखाएं।

स्थानशाखाएं
स्थान स्थान

IOT

6

डिवाइस, साइट, बॉक्स, अलर्ट, इवेंट और साइनेज सामग्री।

IoT डिवाइसiot-sitesiot-अलर्टiot-eventsIoT-बॉक्सiot-signage-content
iot IOT हब

एआई स्टूडियो

3

जनरेट की गई संपत्तियां, उन्हें रखने वाली परियोजनाएं और कार्य इतिहास।

एआई-एसेट्सai-projectsai-jobs
ai_studio एआई स्टूडियो

कॉमर्स

3

नेटवर्क सदस्य, कोटेशन अनुरोध और संग्रह।

नेटवर्क सदस्यकोट-अनुरोधसंग्रह
कॉमर्स कॉमर्स

ई-हस्ताक्षर

2

हस्ताक्षर अनुरोध और उनके विरुद्ध एकत्र किए गए हस्ताक्षर।

हस्ताक्षर अनुरोधहस्ताक्षर
हस्ताक्षर e-Sign

अनुमोदन

2

अनुमोदन अनुरोध और उन्हें रूट करने वाले नियम।

approval-requestsअनुमोदन-नियम
अनुमोदन अनुमोदन

फ़ाइलें

2

अपलोड की गई फ़ाइलें और स्कैन किए गए दस्तावेज़।

फ़ाइलेंस्कैन किए गए दस्तावेज़
फ़ाइलें फ़ाइलें

गतिविधि

3

गतिविधि फ़ीड, ऑडिट लॉग और सूचनाएँ।

गतिविधियाँऑडिट-लॉगसूचनाएं
फ़ोन पर

हर वह मॉड्यूल जिसे API पढ़ता है, आपकी टीम उसे अपने हाथ में खोल सकती है।

यह वह हिस्सा है जो आमतौर पर सच नहीं होता। कई प्लेटफॉर्म एक व्यापक API प्रदान करते हैं और फिर एक मोबाइल ऐप जारी करते हैं जो तीन काम करता है — अप्रूव करना, देखना, सूचित करना। Kardopal का ऐप उत्पाद है, कोई साथी नहीं: ऊपर दिए गए सभी 29 मॉड्यूल में वास्तविक स्क्रीन हैं, और फोन ही वह जगह है जहाँ अधिकांश काम वास्तव में होता है।

  • इसे पढ़ें, फिर इस पर कार्रवाई करें। आपका इंटीग्रेशन स्टॉक स्तर खींचता है; जिस व्यक्ति को इसे ठीक करना है, वह वही रिकॉर्ड खोलता है, उसे समायोजित करता है और यह उसके नाम पर हस्ताक्षरित होता है।
  • स्कैन करें, शूट करें, साइन करें। बारकोड स्कैनिंग, दस्तावेज़ कैप्चर और ई-हस्ताक्षर फ़ोन-नेटिव हैं — उनका कोई डेस्कटॉप समकक्ष उपयोग करने लायक नहीं है।
  • काउंटर पर ऑफ़लाइन-सहिष्णु। जब कनेक्शन रुकता है, तब भी बिलिंग काउंटर, किचन स्क्रीन और कतार डिस्प्ले काम करते रहते हैं।
  • एक ही लॉगिन, एक ही डेटा, 20 भाषाएँ। दाएँ से बाएँ भाषाओं सहित, ताकि अरबी बोलने वाली टीम को उलटा लेआउट न पढ़ना पड़े।
प्लेटफॉर्म देखें।
फोन पर चलने वाला Kardopal ऐप

एक कुंजी प्राप्त करना।

ऐप खोलें, Platform → API Keys पर जाएँ।कुंजियां आपके अपने टेनेंट पर मालिक या एडमिन द्वारा बनाई जाती हैं। Kardopal में कोई भी आपके लिए उन्हें जारी नहीं करता है।
केवल उन मॉड्यूल को चुनें जिनकी इंटीग्रेशन को आवश्यकता है।एक शॉप-विंडो विजेट को चाहिए आइटम. इसे ज़रूरत नहीं है hr. संकीर्ण कुंजियाँ सुरक्षित रूप से विफल होती हैं।
इसे हेडर के रूप में भेजें, URL में कभी नहीं।X-API-Key: kp_live_… — क्वेरी स्ट्रिंग लॉग, प्रॉक्सी और ब्राउज़र हिस्ट्री में समाप्त होती हैं।
पहले नई कुंजी बनाकर बदलें।दोनों एक साथ काम करते हैं, ताकि आप बिना किसी डाउनटाइम के ट्रैफ़िक को स्थानांतरित कर सकें और पुराने वाले को रद्द कर सकें।

इस पर कुछ बनाएं

API स्वयं को दस्तावेज़ित करता है: ऐप में एक कुंजी बनाएं, इंगित करें curl बेस यूआरएल पर, और यह हर मॉड्यूल, संसाधन और खोज योग्य फ़ील्ड वापस देता है जिसे वह कुंजी एक्सेस कर सकती है।

API कुंजी बनाएं