API

មិនមាន endpoint ឯកជនទេ។ សូម្បីតែសម្រាប់ចំណុចប្រទាក់ក៏ដោយ។

ផលិតផលភាគច្រើនមាន API ពីរ៖ មួយដែលមានឯកសារដែលផ្តល់ឱ្យអ្នក និងមួយដែលគួរឱ្យចាប់អារម្មណ៍ដែលអេក្រង់របស់ពួកគេប្រើ។ ទីពីរជាធម្មតាល្អជាង ហើយអ្នកមិនដែលត្រូវបានអនុញ្ញាតឱ្យប្រើវាទេ។ នៅទីនេះមានតែមួយ ហើយចំណុចប្រទាក់គឺជាក្រុមអតិថិជនរបស់វាដូចអ្វីៗផ្សេងទៀត — ដែលជាការរឹតបន្តឹងលើយើង និងជាមូលហេតុដែលអ្វីៗដែលអ្នកចង់សាងសង់អាចធ្វើបាន។

តម្លៃពិតប្រាកដនៃក្បួននេះ

វាមានន័យថាអេក្រង់មួយចំនួនត្រូវរង់ចាំ API ឱ្យត្រឹមត្រូវ ជំនួសឱ្យការប្រើប្រាស់វាដោយផ្ទាល់សម្រាប់ទិន្នន័យតែមួយដែលងាយស្រួល។ ថ្ងៃដែលអេក្រង់ត្រូវការអ្វីមួយដែល API សាធារណៈមិនអាចផ្តល់បាន គឺជាថ្ងៃដែល API មិនត្រឹមត្រូវ ហើយដំណោះស្រាយគឺ API។

អត្ថប្រយោជន៍គឺថាក្រុមអតិថិជនខុសគ្នាបីប្រភេទមិនតម្រូវការបន្ថែមច្រើនទេ។ ម៉ាស៊ីន MCP គឺជាក្រុមអតិថិជន។ ក្រឡាដាច (dash-b tile) គឺជាក្រុមអតិថិជន។ ស្គ្រីបរបស់អ្នកគឺជាក្រុមអតិថិជន។ គ្មានអ្នកណាម្នាក់ជាពលករថ្នាក់ទីពីរដែលត្រូវប្រយុទ្ធជាមួយផ្ទៃដែលរចនាសម្រាប់អ្នកផ្សេងទេ ព្រោះគ្មានផ្ទៃផ្សេងទៀតដែលត្រូវធ្វើជាថ្នាក់ទីពីរទេ។

មានឯកសារ និងបានធ្វើតេស្ត

OpenAPI ត្រូវបានបង្កើតនៅ /docs ហើយគ្រប់ផ្លូវមានតេស្តដែលជាឧទាហរណ៍ក្នុងឯកសារ។ ឯកសារដែលសរសេរដាច់ដោយឡែកពីកូដនឹងបាត់បង់ភាពត្រឹមត្រូវក្នុងរយៈពេលមួយខែ; ឯកសារដែលធ្វើឱ្យការសាងសង់បរាជ័យពេលវាខុស នឹងមិនបាត់បង់ទេ។

ការចូលប្រើ

គណនី castomo របស់អ្នក តាមរយៈ authorization code flow ជាមួយ PKCE — គណនីដូចគ្នាដែលអ្នកប្រើសម្រាប់ dash-b និងគ្រួសារផ្សេងទៀត។ ទំព័រដែលគ្មានម៉ាស៊ីនបម្រើផ្ទាល់ខ្លួនអាចដំណើរការ flow នោះបានយ៉ាងល្អ; វាគឺជាអ្វីដែល flow ត្រូវបានរចនាសម្រាប់។ សម្រាប់ការធ្វើការរវាងម៉ាស៊ីនទៅម៉ាស៊ីន ប្រើ API key ក្នុងកម្រិតគម្រោង។

ផ្ទៃប្រើប្រាស់api.clicksomo.com

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/* នៅលើម៉ាស៊ីនតាមដាន

OpenAPI នៅ /docs/mcp នៅលើដំណើរការដូចគ្នា

ទម្រង់និយម

ទម្រង់ដូចគ្នានឹងសេវាកម្ម castomo ផ្សេងទៀតទាំងអស់

ដែលសំខាន់ជាងអ្វីដែលឮ។ ប្រសិនបើអ្នកបានហៅសេវាមួយរួចហើយ អ្នកបានដឹងរួចហើយពីរបៀបដែលសេវានេះឆ្លើយតប បរាជ័យ និងបែងចែកទំព័រ។

ស្រោបកំហុសតែមួយ

គ្រប់ការបរាជ័យមានទម្រង់ដូចគ្នា កូដស្ថិរភាព និងសារដែលមានបំណងសម្រាប់មនុស្សអាន។ គ្មានផ្លូវណាមួយប្រឌិតវិធីផ្ទាល់ខ្លួនក្នុងការមិនរីករាយទេ។

ការបែងចែកទំព័រដោយ cursor

មិនមែនជា offsets ទេ។ បញ្ជីដែលផ្លាស់ប្តូរពេលអ្នកកំពុងដើរតាមវា មិនស្ងាត់ៗរំលងឬធ្វើម្តងទៀតជួរទេ ដែលការបែងចែកដោយ offset ធ្វើយ៉ាងស្ងាត់ និងជាប្រចាំ។

គន្លឹះ idempotency

នៅលើគ្រប់ផ្លូវដែលផ្លាស់ប្តូរទិន្នន័យ។ ព្យាយាមឡើងវិញនូវសំណើដែលអ្នកមិនច្បាស់ថាទៅដល់ ហើយទទួលបានចម្លើយដូចគ្នា ជំនួសឱ្យទំនាក់ទំនងទីពីរ កំណាត់ទីពីរ ឬការផ្ញើទីពីរ។

កំណត់ក្នុងកម្រិតគម្រោង

Token មួយដាក់បញ្ជាក់ tenant មួយ និងគម្រោងមួយ ទាំងពីរ។ សុវត្ថិភាពកម្រិតជួរត្រូវបានអនុវត្តនៅក្នុងមូលដ្ឋានទិន្នន័យផ្ទាល់ មិនមែនដោយចាំបន្ថែមឃ្លាទេ។

Webhooks ចេញ

មានហត្ថលេខា ព្យាយាមឡើងវិញជាមួយ backoff និងដឹកជញ្ជូនយ៉ាងតិចម្តង — ដូច្នេះ endpoint របស់អ្នកក៏គួរមាន idempotency ដែរ។ ព្រឹត្តិការណ៍ទាំងនោះប្រើពាក្យសព្ទដូចគ្នានឹងរបាយការណ៍។

ការលុបចោល និងការនាំចេញ

ទំនាក់ទំនងមួយអាចត្រូវបាននាំចេញ ឬលុបចោលតាមរយៈ API ហើយការលុបចោលនឹងទៅដល់សេវាកម្មគ្រប់ខ្ទង់ភ្ជាប់ដែលកាន់កាប់ច្បាប់ចម្លង តាមរយៈផ្លូវផ្ទៃក្នុងរបស់ក្រុមគ្រួសារ។

អ្វីៗទាំងអស់ដែលចំណុចប្រទាក់អាចធ្វើបាន POST ក៏អាចធ្វើបានដែរ។

ព្រឹត្តិការណ៍គឺជាផ្នែកដែលគួរឱ្យចាប់អារម្មណ៍

អ្វីៗផ្សេងទៀតនៅលើទំព័រនេះគឺជាប្រព័ន្ធបង្ហូរដែលអ្នករំពឹងទុក។ POST /v1/events គឺជាផ្លូវដែលផ្លាស់ប្តូរគោលបំណងពិតប្រាកដរបស់ផលិតផល។

កម្មវិធីរបស់អ្នកដឹងពីអ្វីៗដែលឧបករណ៍ទីផ្សារណាមួយមិនអាចសង្កេតឃើញ៖ អ្នកណាបានបញ្ចប់ការចាប់ផ្តើមប្រើប្រាស់ អ្នកណាបានអញ្ជើញសហការី អ្នកណាបានប៉ះដល់ដែនកំណត់ អ្នកណាបាននាំចេញទិន្នន័យរបស់ខ្លួននៅរសៀលថ្ងៃអាទិត្យ។ បង្ហោះពួកវាជាព្រឹត្តិការណ៍ជាមួយ token របស់អ្នក ហើយនីមួយៗនឹងក្លាយជាកត្តាដុះ លក្ខខណ្ឌ និងក្រុម។

អ្វីៗដែលនៅសល់បណ្តាលមកពីម៉ូដែលទំនាក់ទំនង។ ព្រឹត្តិការណ៍ត្រូវបានបន្ថែម មិនដែលកែសម្រួលទេ។ ពួកវាគឺជាកំណត់ហេតុដែលផលិតផលទាំងមូលពឹងផ្អែកលើ។ Funnel ដែលដុះលើព្រឹត្តិការណ៍ដែលអ្នកកំណត់ មិនមែនជាការរួមបញ្ចូលទេ — វាគឺជាយន្តការដូចគ្នាដែល message_opened ប្រើ គ្រាន់តែឈ្មោះខុសគ្នាប៉ុណ្ណោះ។

ព្រឹត្តិការណ៍របស់អ្នកក្លាយជា funnelapi_event

1អ្នកបង្ហោះវាPOST /v1/events — ឈ្មោះមួយ ទំនាក់ទំនងមួយ payload មួយ និង idempotency key មួយ។
2វាទៅដល់ត្រូវបានបន្ថែមទៅកំណត់ហេតុរបស់ទំនាក់ទំនង។ គ្មានអ្វីផ្សេងត្រូវដឹងថាវាមាននៅឡើយទេ។
3Funnel មួយចាប់ផ្តើមFunnel ណាមួយដែលចំណុចចូលរបស់វាឈ្មោះព្រឹត្តិការណ៍នោះ សម្រាប់ទំនាក់ទំនងណាមួយដែលមានសិទ្ធិតាមលក្ខខណ្ឌចូលរបស់វា។
4Funnel ផ្សេងទៀតបែងចែកលើវា"ព្រឹត្តិការណ៍នេះបានកើតឡើងក្នុងរយៈពេល ១៤ ថ្ងៃចុងក្រោយឬទេ" គឺជាលក្ខណៈវិនិច្ឆ័យក្រុមធម្មតាមួយ។
iហើយវាបញ្ចប់ដំណើរការថ្នាក់កំណត់គោលដៅដែលឈ្មោះព្រឹត្តិការណ៍ដូចគ្នា បញ្ឈប់លំដាប់នោះភ្លាមៗនៅពេលដែលបុគ្គលធ្វើអ្វីនោះ។

បញ្ជីពាក្យសព្ទរបស់អ្នកToken របស់អ្នក

ដែនកំណត់ដែលគួរដឹងមុនពេលអ្នកសាងសង់

ClickSomo រក្សាទុកអត្តសញ្ញាណបីយ៉ាងអំពីអ្នក — tenant មួយ project មួយ និង user មួយ ជា id ដែលមិនអាចអានបាន — ហើយគ្មានអ្វីផ្សេងទៀត។ គ្មានពាក្យសម្ងាត់ គ្មានព័ត៌មានប្រវត្តិរូប គ្មានកាត គ្មានវិក្កយបត្រ។ ដែនកំណត់ផែនការមកដល់ជាលេខ៖ ទំនាក់ទំនងប៉ុន្មាន ការផ្ញើប៉ុន្មាន ការបង្កើតប៉ុន្មាន។ ពាក្យសព្ទទូទាត់មិនឆ្លងកាត់ខ្សែនោះទេ ទាំងផ្នែកម្ខាងនិងផ្នែកម្ខាង។

ទំនាក់ទំនងរបស់អ្នកគឺជារបស់អ្នក។ អ្នកគឺជាអ្នកគ្រប់គ្រងទិន្នន័យ យើងគឺជាអ្នកដែលដំណើរការទិន្នន័យ។ គ្មានផ្លូវណាមួយដែលផលិតផលផ្សេងទៀតក្នុងក្រុមគ្រួសារអាចអាន ឬសរសេរបញ្ជីទំនាក់ទំនងរបស់អ្នកបានទេ ហើយគ្មានផ្លូវ ingest សម្រាប់វាប្រើដែរ។

ប្រសិនបើអ្នកកំពុងវាយតម្លៃវាយ៉ាងពិតប្រាកដ៖ សូមអាន /docs មុនពេលអ្នកអានអ្វីៗបន្ថែមទៀតនៅលើគេហទំព័រនេះ។ API គឺជាការពិពណ៌នាដ៏ត្រឹមត្រូវអំពីអ្វីដែលផលិតផលធ្វើ ហើយរាល់ការអះអាងនៅលើទំព័រទាំងនេះភ្ជាប់ទៅផ្លូវ ឬប្រភេទថ្នាក់ដែលអ្នកអាចរកឃើញនៅទីនោះ។ ពេល schema ផ្លាស់ប្តូរ ទំព័រទាំងនេះក៏ផ្លាស់ប្តូរដែរ។