API
कुनै निजी एन्डपोइन्ट छैन। इन्टरफेसका लागि पनि होइन।
धेरैजसो उत्पादनहरूमा दुई API हुन्छन्: तपाईंलाई प्रस्ताव गरिने लिखित एउटा, र तिनीहरूकै स्क्रिनहरूले प्रयोग गर्ने रोचक अर्को। दोस्रो सधैं राम्रो हुन्छ, र तपाईंलाई त्यसको नजिक कहिल्यै जान दिइँदैन। यहाँ एउटै छ, र इन्टरफेस अरू जस्तै यसको क्लाइन्ट हो — जुन हाम्रा लागि एक बाध्यता हो, र तपाईंले बनाउन चाहनुहुने सबै कुरा सम्भव हुनुको कारण पनि।
यो नियमले वास्तवमै के खर्च गर्छ
यसको अर्थ कहिलेकाहीँ स्क्रिनले API सही हुन पर्खनुपर्छ, एउटा सुविधाजनक फिल्डका लागि यसलाई छोडेर जानुको सट्टा। स्क्रिनलाई सार्वजनिक API ले दिन नसक्ने कुनै कुरा चाहिएको दिन नै API गलत भएको दिन हो, र समाधान API नै हो।
यसको फाइदा यो हो कि तीन फरक-फरक क्लाइन्टहरूलाई लगभग कुनै थप लागत लाग्दैन। MCP सर्भर एक क्लाइन्ट हो। dash-b को टाइल एक क्लाइन्ट हो। तपाईंको आफ्नै स्क्रिप्ट एक क्लाइन्ट हो। तीमध्ये कोही पनि अरू कसैका लागि डिजाइन गरिएको सतहलाई छोडेर जाने दोस्रो-दर्जाको नागरिक होइन, किनकि दोस्रो हुने अरू कुनै सतह नै छैन।
लिखित, र परीक्षित
OpenAPI /docs मा जेनेरेट हुन्छ र प्रत्येक रुटको एउटा परीक्षण हुन्छ जुन दस्तावेजमा दिइएको उदाहरण हो। कोडबाट छुट्टै लेखिने दस्तावेज एक महिनाभित्रै तल्चिन्छ; गलत हुँदा बिल्ड असफल हुने दस्तावेज तल्चिँदैन।
साइन इन गर्दै
तपाईंको castomo खाता, PKCE सहितको authorization code flow मार्फत — 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अन्य फनेलहरू त्यसैमा शाखा बनाउँछन्"यो घटना गत १४ दिनमा भएको छ कि छैन" भन्ने एउटा सामान्य सेगमेन्ट शर्त हो।
- iर यसले चलिरहेका रनहरू टुङ्ग्याउँछत्यही घटनाको नाम लिने लक्ष्य नोडले व्यक्तिले त्यो काम गरेको क्षणमै क्रम रोकिदिन्छ।
तपाईंको शब्दावलीतपाईंको टोकन
निर्माण गर्नुअघि जान्न लायक सीमाहरू
ClickSomo ले तपाईंबारे तीन पहिचानकर्ता मात्र राख्छ — एउटा टेनेन्ट, एउटा परियोजना र एउटा प्रयोगकर्ता, अपारदर्शी आईडीका रूपमा — र अरू केही होइन। कुनै पासवर्ड, प्रोफाइल, कार्ड वा बिल हुँदैन। योजनाका सीमाहरू सङ्ख्याका रूपमा आउँछन्: कति सम्पर्क, कति पठाइ, कति जनरेसन। भुक्तानीको शब्दावली त्यो सीमा कुनै पनि दिशामा पार गर्दैन।
तपाईंका सम्पर्क तपाईंकै हुन्। तपाईं डाटा नियन्त्रक हुनुहुन्छ; हामी प्रोसेसर हौं। परिवारको अरू कुनै उत्पादनले तपाईंको सम्पर्क सूची पढ्न वा लेख्न सक्ने कुनै मार्ग छैन, र त्यसका लागि कुनै इनजेस्ट माध्यम पनि छैन।
यदि तपाईं यसलाई गम्भीर रूपमा मूल्याङ्कन गर्दै हुनुहुन्छ भने: यो वेबसाइटको अझै धेरै पढ्नुअघि /docs पढ्नुहोस्। API नै उत्पादनले के गर्छ भन्ने इमानदार विवरण हो, र यी पृष्ठहरूको हरेक दाबी त्यहाँ पाइने कुनै मार्ग वा नोड प्रकारसँग मेल खान्छ। स्किमा बदलिँदा यी पृष्ठहरू पनि बदलिन्छन्।