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