API
कवनो निजी एंडपॉइंट नइखे। इंटरफ़ेस खातिरो नइखे।
ज्यादातर प्रोडक्ट में दू गो API होला: दस्तावेज़ीकृत वाला जवन रउआँ के दिहल जाला, आ दिलचस्प वाला जवन ओहन के अपना स्क्रीन इस्तेमाल करेला। दूसरा हमेशा बेहतर होला, आ रउआँ के कब्बो ओकरा पास जाए के इजाजत ना मिलेला। इहाँ एकही बा, आ इंटरफ़ेस ओकरा के अउरी कवनो चीज के तरह एगो क्लाइंट बा — ई हमनी के ऊपर एगो पाबंदी बा, आ रउआँ जवन बनावल चाहत बानी ऊ सब संभव होखे के एही कारण बा।
एह नियम के असल खर्चा का बा
एकर मतलब बा कि कबो-कबो स्क्रीन के API के सही होखे के इंतजार करे के पड़ेला, एगो सुविधाजनक फ़ील्ड खातिर ओकरा के बाईपास ना करे के। जवन दिन कवनो स्क्रीन के अइसन चीज चाही जवन सार्वजनिक API ना दे सके, ऊ दिन API गलत बा, आ समाधान API में बा।
फायदा ई बा कि तीन गो बहुत अलग-अलग क्लाइंट लगभग कवनो अतिरिक्त खर्चा ना लेवेला। MCP सर्वर एगो क्लाइंट बा। dash-b के टाइल एगो क्लाइंट बा। रउआँ के अपना स्क्रिप्ट एगो क्लाइंट बा। कवनो दूसरे के खातिर बनावल सतह के आसपास काम करे वाला दूसरा दर्जा के नागरिक नइखे, काहेकि दूसरा कोई सतहे नइखे जवना के नीचे रहे के पड़े।
दस्तावेज़ीकृत, आ परखल गइल
OpenAPI /docs प बनल जाला आ हर रूट के एगो टेस्ट बा जवन दस्तावेज़ में दिहल उदाहरण ह। कोड से अलग लिखल दस्तावेज़ एक महीना में पुरान हो जाला; गलत होखे प बिल्ड फेल करे वाला दस्तावेज़ ना होखेला।
साइन इन कइल
PKCE के साथे authorization code flow के ऊपर रउआँ के castomo खाता — ऊहे खाता जवन रउआँ dash-b आ परिवार के बाकी चीजन में इस्तेमाल करत बानी। अपना सर्वर ना भइल पन्ना ऊ प्रवाह बखूबी चला सकेला; ईहे ऊ प्रवाह बनावे के मकसद रहल। मशीन-से-मशीन काम खातिर, प्रोजेक्ट-स्कोप वाला API कुंजी।
- 1लोग
/v1/contacts·/lists·/segments·/tags·/imports - 2सामग्री
/v1/creatives, हर टारगेट खातिर सत्यापन, प्रीव्यू आ रेंडर के साथे - 3ऑटोमेशन
/v1/funnels·/funnels/:id/versions·/runs·/simulate - 4ब्रॉडकास्ट
/v1/campaigns, ऑडियंस, मटेरियलाइज़, शेड्यूल आ भेजल अलग-अलग चरण के रूप में - 5इवेंट भीतर
/v1/events— रउआँ के अपना एप्लिकेशन के इवेंट, ट्रिगर के रूप में - 6डिलीवरी
/sender-identities·/domains·/apps·/webhooks - 7आँकड़ा
/v1/reports/*, आ ट्रैकिंग होस्ट प/track/*
/docs प OpenAPIएही प्रोसेस प /mcp
परंपरा
हर दूसरा castomo सेवा जइसन एही आकार
ई सुने में जइसन लागेला ऊसे ज्यादा मायने रखेला। अगर रउआँ पहिले से इनहन में से कवनो एक के कॉल करत बानी, त रउआँ पहिले से जानत बानी कि ई कइसे जवाब देला, फेल होला आ पेजिनेट करेला।
एक गो त्रुटि लिफाफा
हर विफलता के एही आकार बा, एगो स्थिर कोड आ इंसान खातिर बनावल संदेश। कवनो रूट अपने दुख होखे के अपना तरीका ना बनावेला।
कर्सर पेजिनेशन
ऑफ़सेट ना। जवना लिस्ट प रउआँ चलत घरी बदलाव होत रहे, ऊ चुपचाप पंक्ति छोड़े या दोहरा ना — जवना के ऑफ़सेट पेजिनेशन चुपके से लगातार करेला।
आइडेम्पोटेंसी कुंजी
हर बदलाव करे वाला रूट प। जवन अनुरोध रउआँ के पक्का ना बा कि पहुँचल, ओकरा के दोबारा भेजी आ एही जइसन जवाब पाई — दूसरा संपर्क, दूसरा कैंपेन या दूसरा भेजाइ ना।
प्रोजेक्ट तक सीमित
एगो टोकन एक गो टेनेंट आ एक गो प्रोजेक्ट, दुनो के संबोधित करेला। पंक्ति-स्तरीय सुरक्षा डेटाबेस मेंहे लागू बा, कवनो खंड जोड़े के याद राखे प ना।
वेबहुक बाहर
हस्ताक्षरित, बैकऑफ़ के साथे दोबारा भेजल जात, आ कम से कम एक बेर डिलीवर होला — एहसे रउआँ के एंडपॉइंट के भी आइडेम्पोटेंट होखे के चाही। इवेंट ऊहे शब्दावली बा जवन रिपोर्ट इस्तेमाल करेला।
मिटावल आ निर्यात
कौनो संपर्क के API के जरिए निर्यात भा मिटावल जा सकता, आ मिटावल परिवार के आपन भीतरी मार्ग से ओह हर भाई-बहिन सेवा तक पहुँच जाला जवना के पास ओकर प्रति रहल।
इंटरफेस जा कर सकता, POST ऊ सब कर सकता।
घटना सबे रोचक हिस्सा बाड़ी
एह पन्ना पर बाकी सब उहू प्लंबिंग बा जवना के रउआँ अपेक्षा करत रहब। POST /v1/events ऊ रास्ता बा जवन ई बतावेला कि उत्पाद के काम का बा।
रउआँ के आवेदन पहिले से ऊ बात जानेला जवन कौनो मार्केटिंग औजार ना देख सकता: के ऑनबोर्डिंग पूरा कइलस, के सहकर्मी के बुलावलस, के सीमा छुवलस, के रविवार के दोपहर में आपन डेटा निर्यात कइलस। अपना टोकन से इनहन के घटना के रूप में भेजीं, आ हर एक ट्रिगर, शर्त आ विभाग बन जात।
बाकी सब संपर्क मॉडल से निकलेला। घटना जोड़ल जालीं, कबो संपादित ना; ई ऊ लॉग बाड़ी जवना पर पूरा उत्पाद टिकल बा। रउआँ के परिभाषित कइल घटना पर चले वाला फ़नल कौनो एकीकरण ना — ई वही तंत्र बा जवन message_opened इस्तेमाल करेला, बस भीतर नाँव अलग बा।
- 1रउआँ एकरा के भेजब
POST /v1/events— एगो नाँव, एगो संपर्क, एगो पेलोड, एगो आइडेंपोटेंसी कुंजी। - 2ई पहुँच जालासंपर्क के लॉग में जोड़ल जाला। बाकी केहू के एकर अस्तित्व के जानकारी होखे के जरूरत ना।
- 3एगो फ़नल शुरू होलाकवनो भी फ़नल जवना के प्रवेश उहू घटना के नाँव लेला, उहू संपर्क खातिर जे ओकर प्रवेश विनिर्देश के अंतर्गत पात्र बा।
- 4अउरी फ़नल एह पर शाखा करेला"ई घटना पिछला 14 दिन में भइल बा कि ना" एगो साधारण विभाग विधेय बा।
- iआ ई चलन खत्म करेलाएही घटना के नाँव लेवे वाला लक्ष्य नोड ओह क्षण अनुक्रम रोक देला जब व्यक्ति ऊ काम कर लेला।
रउआँ के शब्दावलीरउआँ के टोकन
बनावे से पहिले जानल लायक सीमा
ClickSomo रउआँ के बारे में तीन पहचानकर्ता रखेला — एगो टेनेंट, एगो प्रोजेक्ट आ एगो उपयोगकर्ता, अपारदर्शी आईडी के रूप में — आ आगे कुछ ना। कौनो पासवर्ड ना, कौनो प्रोफ़ाइल ना, कौनो कार्ड ना, कौनो चालान ना। योजना के सीमा संख्या के रूप में आवेला: केतना संपर्क, केतना भेजल, केतना पीढ़ी। भुगतान के शब्दावली उहाँ से दुनों ओर ना गुजरेला।
रउआँ के संपर्क रउआँ के अपना बाड़ें। रउआँ डेटा नियंत्रक बानी; हमरा प्रोसेसर बानी। एह परिवार के दूसरा उत्पाद रउआँ के संपर्क सूची पढ़े भा लिखे के कौनो रास्ता ना, आ केहू इस्तेमाल करे खातिर कौनो इनजेस्ट मार्ग ना।
अगर रउआँ एकरा के गंभीरता से आँकत बानी: एह वेबसाइट के आगे पढ़े से पहिले /docs पढ़ीं। API ई ईमानदार विवरण बा कि उत्पाद का करेला, आ इन्हन पन्ना पर कइल हर दावा ओहाँ मिले वाला कौनो रास्ता भा नोड प्रकार से मेल खाला। जब स्कीमा बदलेला, ई पन्ना बदल जाला।