Το API
Δεν υπάρχει ιδιωτικό endpoint. Ούτε καν για τη διεπαφή.
Τα περισσότερα προϊόντα έχουν δύο API: το τεκμηριωμένο που σας προσφέρουν, και το «ενδιαφέρον» που χρησιμοποιούν οι δικές τους οθόνες. Το δεύτερο είναι πάντα καλύτερο, και δεν σας επιτρέπεται ποτέ να το πλησιάσετε. Εδώ υπάρχει ένα, και η διεπαφή είναι πελάτης του όπως οτιδήποτε άλλο — αυτό είναι ένας περιορισμός για εμάς, και ο λόγος που όλα όσα θέλετε να χτίσετε είναι εφικτά.
Τι κοστίζει πραγματικά αυτός ο κανόνας
Σημαίνει ότι μια οθόνη καμιά φορά πρέπει να περιμένει το API να γίνει σωστό, αντί να παρακάμψει το API για ένα βολικό πεδίο. Η μέρα που μια οθόνη χρειάζεται κάτι που το δημόσιο API δεν μπορεί να της δώσει είναι η μέρα που το API είναι λάθος, και η λύση είναι το API.
Το όφελος είναι ότι τρεις πολύ διαφορετικοί πελάτες δεν κοστίζουν σχεδόν τίποτα επιπλέον. Ο διακομιστής MCP είναι πελάτης. Ένα tile του dash-b είναι πελάτης. Το δικό σας σκριπτ είναι πελάτης. Κανένας τους δεν είναι πολίτης δεύτερης κατηγορίας που παρακάμπτει μια επιφάνεια σχεδιασμένη για άλλον, επειδή δεν υπάρχει άλλη επιφάνεια στην οποία να είναι δεύτερος.
Τεκμηριωμένο, και δοκιμασμένο
Το OpenAPI παράγεται στο /docs και κάθε διαδρομή έχει ένα test που είναι το παράδειγμα της τεκμηρίωσης. Η τεκμηρίωση που γράφεται χωριστά από τον κώδικα αποκλίνει μέσα σε έναν μήνα· η τεκμηρίωση που αποτυγχάνει στο build όταν είναι λάθος, όχι.
Σύνδεση
Ο λογαριασμός σας στο castomo, μέσω της ροής εξουσιοδότησης με PKCE — ο ίδιος λογαριασμός που χρησιμοποιείτε για το 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/*στον host παρακολούθησης
OpenAPI στο /docs/mcp στην ίδια διεργασία
Συμβάσεις
Το ίδιο σχήμα με κάθε άλλη υπηρεσία του castomo
Και αυτό έχει μεγαλύτερη σημασία απ' όσο ακούγεται. Αν ήδη καλείτε μία από αυτές, ξέρετε ήδη πώς απαντά, αποτυγχάνει και σελιδοποιεί αυτή.
Ένα φάκελο σφαλμάτων
Κάθε αποτυχία έχει το ίδιο σχήμα, έναν σταθερό κωδικό και ένα μήνυμα για άνθρωπο. Καμία διαδρομή δεν επινοεί τον δικό της τρόπο να δυσαρεστεί.
Σελιδοποίηση με δείκτη (cursor)
Όχι μετατοπίσεις. Μια λίστα που αλλάζει ενώ τη διατρέχετε δεν παραλείπει ούτε επαναλαμβάνει σιωπηλά γραμμές, κάτι που η σελιδοποίηση με μετατοπίσεις κάνει ήσυχα και συνεχώς.
Κλειδιά idempotency
Σε κάθε διαδρομή που αλλάζει δεδομένα. Επαναλάβετε ένα αίτημα για το οποίο δεν είστε σίγουροι ότι κατέληξε και πάρετε την ίδια απάντηση, αντί για δεύτερη επαφή, δεύτερη καμπάνια ή δεύτερη αποστολή.
Εστιασμένο σε έργο
Ένα token απευθύνεται σε έναν tenant και σε ένα έργο, και τα δύο. Η ασφάλεια σε επίπεδο γραμμής επιβάλλεται στην ίδια τη βάση δεδομένων, όχι με το να θυμάστε να προσθέσετε έναν όρο.
Εξερχόμενα webhooks
Υπογεγραμμένα, με επαναλήψεις και backoff, και με παράδοση τουλάχιστον μία φορά — ώστε και το endpoint σας να πρέπει να είναι idempotent. Τα συμβάντα χρησιμοποιούν το ίδιο λεξιλόγιο με τις αναφορές.
Διαγραφή και εξαγωγή
Μια επαφή μπορεί να εξαχθεί ή να διαγραφεί μέσω του API, και μια διαγραφή φτάνει σε κάθε αδελφή υπηρεσία που κατείχε αντίγραφο, μέσω του δικού της εσωτερικού καναλιού της οικογένειας.
Ό,τι μπορεί να κάνει η διεπαφή, μπορεί να το κάνει ένα POST.
Τα γεγονότα είναι το ενδιαφέρον μέρος
Όλα τα άλλα σε αυτή τη σελίδα είναι η υποδομή που θα περιμένατε. Το POST /v1/events είναι η διαδρομή που αλλάζει τον σκοπό του προϊόντος.
Η εφαρμογή σας γνωρίζει ήδη πράγματα που κανένα εργαλείο μάρκετινγκ δεν μπορεί να παρατηρήσει: ποιος ολοκλήρωσε την εγκατάσταση, ποιος προσκάλεσε συνάδελφο, ποιος έφτασε σε όριο, ποιος εξήγαγε τα δεδομένα του ένα Κυριακάτικο απόγευμα. Δημοσιεύστε τα ως γεγονότα με το δικό σας token, και το καθένα γίνεται έναυσμα, συνθήκη και τμήμα.
Τα υπόλοιπα προκύπτουν από το μοντέλο της επαφής. Τα γεγονότα προστίθενται, δεν επεξεργάζονται ποτέ· είναι το ημερολόγιο στο οποίο στηρίζεται όλο το προϊόν. Ένα funnel που ενεργοποιείται από ένα γεγονός που ορίσατε δεν είναι μια ενσωμάτωση — είναι ο ίδιος μηχανισμός που χρησιμοποιεί το message_opened, με διαφορετικό όνομα μέσα του.
- 1Εσείς το δημοσιεύετε
POST /v1/events— ένα όνομα, μια επαφή, ένα payload, ένα κλειδί idempotency. - 2ΦτάνειΠροστίθεται στο ημερολόγιο της επαφής. Κανένα άλλο στοιχείο δεν χρειάζεται να γνωρίζει ότι υπάρχει.
- 3Ξεκινά ένα funnelΟποιοδήποτε funnel του οποίου η είσοδος ονομάζει αυτό το γεγονός, για κάθε επαφή επιλέξιμη βάσει των κριτηρίων εισόδου του.
- 4Άλλα funnel διακλαδίζονται πάνω τουΤο «Έχει συμβεί αυτό το γεγονός τις τελευταίες 14 ημέρες» είναι ένα συνηθισμένο κριτήριο τμήματος.
- iΚαι τερματίζει εκτελέσειςΈνας κόμβος στόχου που ονομάζει το ίδιο γεγονός σταματά μια ακολουθία τη στιγμή που το άτομο κάνει την πράξη.
Το λεξιλόγιό σαςΤο token σας
Όρια που αξίζει να γνωρίζετε πριν ξεκινήσετε
Το ClickSomo αποθηκεύει τρία αναγνωριστικά για εσάς — έναν tenant, ένα έργο και έναν χρήστη, ως αδιαφανή ids — και τίποτα άλλο. Κανέναν κωδικό, κανένα προφίλ, καμία κάρτα, κανένα τιμολόγιο. Τα όρια του πλάνου φτάνουν ως αριθμοί: πόσες επαφές, πόσες αποστολές, πόσες δημιουργίες. Το λεξιλόγιο των πληρωμών δεν διαπερνά αυτή τη γραμμή προς καμία κατεύθυνση.
Οι επαφές σας είναι δικές σας. Εσείς είστε ο υπεύθυνος επεξεργασίας δεδομένων· εμείς είμαστε ο εκτελεστής. Δεν υπάρχει διαδρομή με την οποία άλλο προϊόν της οικογένειας να μπορεί να διαβάσει ή να γράψει τη λίστα επαφών σας, ούτε κανάλι εισαγωγής για να χρησιμοποιήσει.
Αν το αξιολογείτε σοβαρά: διαβάστε το /docs πριν διαβάσετε οτιδήποτε άλλο σε αυτόν τον ιστότοπο. Το API είναι η ειλικρινής περιγραφή του τι κάνει το προϊόν, και κάθε δήλωση σε αυτές τις σελίδες αντιστοιχεί σε μια διαδρομή ή έναν τύπο κόμβου που θα βρείτε εκεί. Όταν αλλάζει το schema, αλλάζουν και αυτές οι σελίδες.