Οδηγός ενσωμάτωσης του Housing Market API
Οι πίνακες αναφοράς, οι περιγραφές των τελικών σημείων, οι κωδικοί σφαλμάτων και τα παραδείγματα παράγονται από την προδιαγραφή του API και παραμένουν στα αγγλικά σε κάθε γλώσσα. Τα ονόματα, οι παράμετροι και οι κωδικοί είναι παντού ίδιοι.
Έλεγχος ταυτότητας
Στείλτε το κλειδί σας στην κεφαλίδα x-api-key σε κάθε αίτημα.
Κρατήστε το κλειδί στον διακομιστή σας. Μην το τοποθετείτε ποτέ σε εφαρμογή για κινητά, σε ιστοσελίδα ή σε δημόσιο αποθετήριο: όποιος το κατέχει μπορεί να χρησιμοποιήσει τη συνδρομή σας.
Ένα κλειδί ανήκει σε έναν πελάτη. Μην το μοιράζεστε με άλλη εταιρεία· οι όροι το απαγορεύουν και μπορούμε να δούμε από πού χρησιμοποιείται ένα κλειδί.
Ένα κλειδί περιλαμβάνει όλη την πρόσβασή σας: τις χώρες σας και το πρόγραμμά σας. Όταν προσθέτετε χώρα ή κάνετε αναβάθμιση, προσαρμόζεται το ίδιο κλειδί· δεν λαμβάνετε νέο.
Ένα κλειδί που λείπει, είναι άγνωστο ή έχει ανακληθεί απορρίπτεται με unauthenticated. Ένα έγκυρο κλειδί που χρησιμοποιείται από μη καταχωρισμένη διεύθυνση απορρίπτεται με ip_not_allowed. Ένα κλειδί σε παύση απορρίπτεται με key_paused.
Παράδειγμα αιτήματος
curl -H "x-api-key: $HMA_API_KEY" \
"https://api.housingmarketapi.com/v1/ping"