Τεκμηρίωση / Αναφορά API
Η λεπτομέρεια πίσω από την επισκόπηση του API
Αυτή είναι η αναλυτική αναφορά κάτω από τη σελίδα επισκόπησης του API: ακριβώς πώς λειτουργεί η ταυτοποίηση με bearer token, η μορφή αιτήματος και απάντησης για patients και appointments, και κάθε κωδικός σφάλματος που μπορεί να επιστρέψει ένα endpoint.
Ποιο πακέτο χρειάζεται
Η σύνδεση ενός εξωτερικού πελάτη (OAuth και ο MCP server) χρειάζεται το πακέτο Complete, το οποίο περιλαμβάνει και τη δοκιμή 30 ημερών. Ο περιορισμός αφορά την πρόσβαση εξωτερικών εργαλείων, όχι το ίδιο το API: η εφαρμογή καλεί τα ίδια REST endpoints με συνδεδεμένη συνεδρία σε κάθε πακέτο. Ένας πελάτης εγγράφεται μόνος του μέσω δυναμικής εγγραφής OAuth, και τον εγκρίνει ένα συνδεδεμένο μέλος ιατρείου στο Complete. Οι συνδεδεμένες εφαρμογές εμφανίζονται, και αποσυνδέονται, από τις Ρυθμίσεις και μετά Λογαριασμός. Η σελίδα τιμών έχει κάθε κλίμακα.
Πώς να χρησιμοποιήσετε αυτή την αναφορά
Όλα τα endpoints βρίσκονται κάτω από το /api/v1. Εκτός από τα endpoints δημόσιων κρατήσεων, φορμών και OAuth, όλα απαιτούν Authorization: Bearer <token>. Οι επιτυχείς απαντήσεις μοιράζονται έναν φάκελο με πεδίο data και requestId· τα σφάλματα μοιράζονται το αντίστροφο σχήμα με code, ένα εμφανίσιμο message, και προαιρετικό details. Οι τέσσερις παρακάτω σελίδες καλύπτουν, με τη σειρά: πώς λειτουργεί το ίδιο το bearer token, τον πόρο patients, τον πόρο appointments, και τον πλήρη πίνακα κωδικών σφάλματος.
Τι δεν καλύπτει αυτή η αναφορά
Τα billing, forms, files, tags, search, reporting και staff/invitations μαζί με έδρες και υπηρεσίες, τον οδοντιατρικό και περιοδοντικό χάρτη, τις ειδοποιήσεις, το ιστορικό ενεργειών, τον συγχρονισμό ημερολογίου και τις εισαγωγές ασθενών, είναι όλα μέρος του API, και οι αναλυτικές σελίδες τους έρχονται. Όλα τους περιλαμβάνονται ήδη στο αναγνώσιμο από μηχανή έγγραφο OpenAPI στο /api/v1/openapi.json, το οποίο καλύπτει κάθε endpoint ενσωμάτωσης και όχι μόνο τους τέσσερις πόρους που περιγράφονται εδώ. Οι διαδρομές του κατασκευαστή ιστότοπου, της τηλεφωνικής γραμμής, των passkey και του βοηθού μέσα στην εφαρμογή είναι μόνο για το dashboard και δεν περιλαμβάνονται. Δεν υπάρχει ακόμη επίσημο SDK πελάτη.
Σελίδες αναφοράς
Αυθεντικοποίηση
Bearer tokens, Firebase ID tokens έναντι OAuth access tokens, και κάθε κωδικός σφάλματος αυθεντικοποίησης.
Ασθενείς
Η μορφή αντικειμένου ασθενή και σημείωσης, κάθε endpoint, και τα πεδία αιτήματος και απάντησής του.
Ραντεβού
Το αντικείμενο ραντεβού, οι κανόνες επικάλυψης/διπλής κράτησης, και το endpoint διαθεσιμότητας.
Σφάλματα
Ο πλήρης πίνακας κωδικών σφάλματος, οι μορφές φακέλου επιτυχίας και σφάλματος, και η συσχέτιση request-id.
Συχνές ερωτήσεις
Το HyperCRM είναι λογισμικό επί πληρωμή. Κάθε ιατρείο ξεκινά με δωρεάν δοκιμή 30 ημερών στο πακέτο Complete, χωρίς κάρτα. Στη συνέχεια τα πακέτα ξεκινούν από 19 € και 34 € τον μήνα, με ΦΠΑ. Η τιμή εξαρτάται από το πόσους επαγγελματίες υγείας απασχολείτε. Κάθε τιμή βρίσκεται στη σελίδα τιμών, οπότε δεν χρειάζεται να μιλήσετε με πωλητή.
Οι καρτέλες ασθενών κρυπτογραφούνται, και εκεί που φυλάσσονται και καθώς έρχονται στην οθόνη σας. Τα αρχεία είναι ιδιωτικά, και ο σύνδεσμος προς ένα αρχείο σταματά να δουλεύει μετά από λίγο. Οι αλλαγές στις καρτέλες των ασθενών καταγράφονται, με το ποιος τις έκανε και πότε. Δεν υπάρχει κοινός κωδικός ιατρείου: ο καθένας έχει τον δικό του λογαριασμό. Στο πακέτο Complete, ο ιδιοκτήτης του ιατρείου μπορεί επίσης να απαιτεί σύνδεση σε δύο βήματα για όλη την ομάδα.
Η σελίδα επισκόπησης στο /developers/api είναι μια αναγνώσιμη περίληψη φτιαγμένη να διαβάζεται μία φορά. Αυτή η ενότητα και οι τέσσερις σελίδες της είναι υλικό αναφοράς: ακριβή ονόματα πεδίων, υποχρεωτικές και προαιρετικές παραμέτρους, κωδικούς κατάστασης και κωδικούς σφάλματος, για να ψάχνετε ένα πράγμα τη φορά ενώ γράφετε πάνω του.
Ναι. Ένα έγγραφο OpenAPI 3.1 δημοσιεύεται στο /api/v1/openapi.json και καλύπτει κάθε endpoint ενσωμάτωσης, όχι μόνο τους πόρους αυτών των σελίδων. Οι διαδρομές μόνο για το dashboard (κατασκευαστής ιστότοπου, τηλεφωνική γραμμή, passkey, βοηθός εντός εφαρμογής) εξαιρούνται. Παράγεται από τα ίδια σχήματα επικύρωσης που επιβάλλει ο διακομιστής, άρα η μορφή αιτήματος είναι αυτή που δέχεται, και ένα test αποτυγχάνει αν αποκλίνουν.