API
ఇక్కడ ప్రైవేట్ ఎండ్‌పాయింట్ లేదు. ఇంటర్‌ఫేస్ కోసం కూడా లేదు.
చాలా ఉత్పత్తులకు రెండు APIలు ఉంటాయి: మీకు అందించే డాక్యుమెంటెడ్ API, వారి స్క్రీన్లు వాడే ఆసక్తికరమైన 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 అనేది ఉత్పత్తి ఏమి చేస్తుందో నిజాయితీ వివరణ, మరియు ఈ పేజీలపై ఉన్న ప్రతి వాదన అక్కడ మీరు కనుగొనగల ఒక మార్గానికి లేదా నోడ్ రకానికి అనుగుణంగా ఉంటుంది. స్కీమా మారినప్పుడు, ఈ పేజీలు మారతాయి.