Οδηγός ενσωμάτωσης του Housing Market API
Οι πίνακες αναφοράς, οι περιγραφές των τελικών σημείων, οι κωδικοί σφαλμάτων και τα παραδείγματα παράγονται από την προδιαγραφή του API και παραμένουν στα αγγλικά σε κάθε γλώσσα. Τα ονόματα, οι παράμετροι και οι κωδικοί είναι παντού ίδιοι.
Λίστα επιτρεπόμενων IP
Ένα κλειδί λειτουργεί μόνο από τη διεύθυνση IP που έχει καταχωριστεί για αυτό. Καταχωρίζετε μία διεύθυνση κατά την εγγραφή της συνδρομής.
Για να μάθετε ποια διεύθυνση βλέπουμε, καλέστε το GET /v1/ping από τον διακομιστή σας. Η απόκριση την επιστρέφει στο πεδίο address. Καταχωρίστε αυτή τη διεύθυνση, όχι τη διεύθυνση του γραφείου ή του φορητού υπολογιστή σας.
Ένα αίτημα από οποιαδήποτε άλλη διεύθυνση απορρίπτεται με ip_not_allowed, ακόμη κι αν το κλειδί είναι σωστό. Γίνονται δεκτές διευθύνσεις τόσο IPv4 όσο και IPv6.
Μπορείτε να αλλάξετε την καταχωρισμένη διεύθυνση στην κονσόλα. Οι αλλαγές καταγράφονται και είναι περιορισμένες, γι' αυτό καταχωρίστε την εξερχόμενη διεύθυνση ενός σταθερού διακομιστή και χρησιμοποιήστε στατική εξερχόμενη διεύθυνση αν λειτουργείτε σε πάροχο cloud.
Αν οι διακομιστές σας βρίσκονται πίσω από διακομιστή μεσολάβησης (proxy) ή πύλη NAT, καταχωρίστε τη διεύθυνση του proxy ή της πύλης, επειδή αυτή είναι η διεύθυνση που βλέπουμε.
GET /v1/ping
Check your key and the address we see
Confirms that the key is accepted from the address the request came from, and echoes that address. Use it to check the IP you registered before you build anything else.
Parameters
No parameters.
Responses
| Status | Description | Error codes |
|---|---|---|
200 | The key is valid and the address is registered. | |
401 | The key is missing, unknown or revoked. | unauthenticated |
403 | The key is valid but this request is refused. | ip_not_allowed key_paused |
429 | A rate limit or a quota has been reached. | rate_limited quota_exceeded |
503 | The service cannot answer right now. | service_unavailable |