Κλειδιά API

Ένα κλειδί API επιτρέπει στον δικό σας ιστότοπο ή λογισμικό να δουλεύει με τον λογαριασμό σας στο Measure Map Online: να εμφανίζει τον χάρτη ενός έργου στον ιστότοπό σας, να ξεκινά έργα για τους επισκέπτες σας ή να διαβάζει και να αλλάζει έργα μέσω του REST API. Δημιουργείτε και διαχειρίζεστε τα κλειδιά στη σελίδα codeΠρογραμματιστής.

Ανοίξτε τη σελίδα Προγραμματιστής#

Στο μενού του πίνακα ελέγχου, κάτω από το Για προχωρημένους, πατήστε codeΠρογραμματιστής. Ανοίγει στα vpn_keyΚλειδιά API και οι υπόλοιπες ενότητές της αναφέρονται από κάτω στο μενού (σε τηλέφωνο, ως καρτέλες στο πάνω μέρος της σελίδας):

• person_pin_circleΣύνδεσμος επισκέπτη (Open Guest): ο σύνδεσμος χωρίς κώδικα για τον ιστότοπό σας. Δείτε το Open Guest.
• terminalΔοκιμάστε το API, webhookWebhooks και apiREST API: δείτε την αναφορά API.
• web_assetΕνσωμάτωση χάρτη (Enterprise): δείτε το iFrame API.
• lock_open Ιδιωτικά έργα (Enterprise): εμφανίστε τα ιδιωτικά έργα των πελατών σας στις ενσωματώσεις σας. Δείτε τα ιδιωτικά έργα των πελατών.

Το σήμα στο πάνω μέρος της κάρτας του κλειδιού λέει αν το κλειδί σας είναι Ενεργή, Μη ενεργοποιημένη (δεν υπάρχει ακόμη κλειδί), Απενεργοποιημένο (η πρόσβαση API έχει ανασταλεί: κανένα κλειδί δεν λειτουργεί και δεν μπορεί να δημιουργηθεί νέο μέχρι να την άρει η υποστήριξη) ή Έληξε (η συνδρομή δεν είναι ενεργή).

Live και Sandbox#

Στο πάνω μέρος της κάρτας του κλειδιού, εναλλάσσεστε ανάμεσα σε public Παραγωγή και science Sandbox. Το καθένα έχει δικό του κλειδί και η σελίδα δείχνει αυτό που διαλέγετε. Η επιλογή ισχύει και στο terminalΔοκιμάστε το API και παραμένει καθώς μετακινείστε ανάμεσα στις ενότητες. Οι ενότητες web_assetΕνσωμάτωση χάρτη και person_pin_circleΣύνδεσμος επισκέπτη χρησιμοποιούν πάντα το live κλειδί σας, επειδή οι επισκέπτες του ιστότοπού σας μπορούν να ανοίγουν μόνο live έργα: όταν ανοίξετε μία από τις δύο, η σελίδα επιστρέφει στο Παραγωγή.

• Το Παραγωγή είναι ο πραγματικός λογαριασμός σας και η σελίδα ανοίγει σε αυτό. Χρησιμοποιήστε ένα live κλειδί στον ιστότοπό σας.
• Το Sandbox είναι για την ανάπτυξη και τη δοκιμή μιας ενσωμάτωσης. Τα έργα, οι φάκελοι και τα προϊόντα που δημιουργούνται με ένα κλειδί sandbox διατηρούνται χωριστά από τα πραγματικά σας: ένα live κλειδί δεν τα βλέπει και ένα κλειδί sandbox δεν βλέπει τα live. Τα αιτήματα που γίνονται με κλειδί sandbox δεν προσμετρώνται στα στοιχεία χρήσης σας και τα έργα επισκεπτών που δημιουργούνται με αυτό δεν χρεώνονται ποτέ.

Η δημιουργία νέου κλειδιού sandbox δεν επηρεάζει ποτέ το live κλειδί σας, και αντίστροφα.

Επιλέξτε τι μπορεί να κάνει το κλειδί#

Όταν δημιουργείτε ένα κλειδί, το παράθυρο διαλόγου παραθέτει κάθε τομέα του API στο Πρόσβαση για το νέο κλειδί. Επιλέξτε πόσο μακριά φτάνει το νέο κλειδί σε καθέναν:

Το παράθυρο δείχνει μόνο τους τομείς που περιλαμβάνει το πρόγραμμά σας. Κρατήστε τον δείκτη πάνω από μια επιλογή για να δείτε ακριβώς τι παραχωρεί. Το πρώτο σας κλειδί ξεκινά μόνο με Ενσωματωμένοι χάρτες, που είναι το μόνο που χρειάζεται ένας ενσωματωμένος χάρτης· ένα κλειδί που αντικαθιστά ένα άλλο ξεκινά με την πρόσβαση εκείνου. Επιλέξτε τουλάχιστον έναν τομέα.

Το τι μπορεί να κάνει ένα κλειδί ορίζεται όταν το δημιουργείτε. Για να δώσετε σε ένα κλειδί περισσότερη ή λιγότερη πρόσβαση, δημιουργήστε νέο.

Δημιουργήστε ένα κλειδί#

1. Επιλέξτε Παραγωγή ή Sandbox στο πάνω μέρος της κάρτας του κλειδιού.
2. Πατήστε addΔημιουργία νέου κλειδιού. Ανοίγει ένα παράθυρο διαλόγου, με public Παραγωγή ή science Sandbox δίπλα στον τίτλο του.
3. Ορίστε την πρόσβαση στο Πρόσβαση για το νέο κλειδί (δείτε παραπάνω).
4. Αν θέλετε, πληκτρολογήστε ένα όνομα στο Όνομα για το νέο κλειδί (προαιρετικό), για να ξεχωρίζετε τα κλειδιά σας.
5. Πατήστε addΔημιουργία.

Στη συνέχεια το παράθυρο γράφει Το νέο κλειδί σας είναι έτοιμο. Μπορείτε να το αντιγράψετε ξανά από αυτή τη σελίδα οποιαδήποτε στιγμή. Δείχνει το κλειδί, κρυμμένο εκτός από τους πρώτους και τους τελευταίους χαρακτήρες του, και τι μπορεί να Μπορεί να κάνει. Πατήστε visibility για να το δείτε ολόκληρο ή content_copy για να αντιγράψετε ολόκληρο το κλειδί και, έπειτα, πατήστε Τέλος. Η κάρτα του κλειδιού το δείχνει με τον ίδιο τρόπο στο Το κλειδί API σας. Λαμβάνετε email κάθε φορά που δημιουργείται κλειδί στον λογαριασμό σας.

Κλειδιά που δημιουργήθηκαν πριν από τις ρυθμίσεις πρόσβασης#

Ένα κλειδί που δημιουργήθηκε πριν τα κλειδιά αποκτήσουν ρυθμίσεις πρόσβασης μπορεί να κάνει τα πάντα εκτός από τη δουλειά με προϊόντα. Τέτοια κλειδιά καταργούνται σταδιακά: η κάρτα του κλειδιού λέει πότε σταματά να λειτουργεί το δικό σας και λαμβάνετε και ειδοποίηση. Πατήστε addΔημιουργία νέου κλειδιού, που η κάρτα δείχνει τότε ως κύριο κουμπί, και αντικαταστήστε το παλιό κλειδί στον ιστότοπο ή τον διακομιστή σας πριν από εκείνη την ημερομηνία. Το παράθυρο ξεκινά μόνο με Ενσωματωμένοι χάρτες, οπότε επιλέξτε περισσότερα αν τα χρειάζεται ο διακομιστής σας.

Αντικαταστήστε ένα κλειδί#

Πατήστε ξανά addΔημιουργία νέου κλειδιού όταν έχετε ήδη κλειδί και δημιουργήστε το νέο στο παράθυρο διαλόγου. Το παράθυρο λέει τι θα συμβεί με το τρέχον κλειδί: Θα δημιουργηθεί ένα νέο κλειδί και το τρέχον κλειδί σας θα συνεχίσει να λειτουργεί για 24 ώρες, ώστε να ενημερώσετε τους ιστότοπους που το χρησιμοποιούν. Μπορείτε να το ανακαλέσετε νωρίτερα όταν τελειώσετε. Ένα κλειδί που δημιουργήθηκε πριν από τις ρυθμίσεις πρόσβασης συνεχίζει να λειτουργεί μέχρι την ημερομηνία που σας δόθηκε.

Το παλιό κλειδί μεταφέρεται στα Προηγούμενα κλειδιά, με τον χρόνο που του απομένει, πότε χρησιμοποιήθηκε τελευταία φορά και τι μπορεί να κάνει. Γίνονται ακόμη δεκτά όσο διαδίδετε το νέο κλειδί. Ανακαλέστε ένα μόλις δεν το χρησιμοποιεί τίποτα. Για να το σταματήσετε αμέσως, πατήστε blockΑνάκληση και επιβεβαιώστε· κάθε ιστότοπος που το χρησιμοποιεί ακόμη σταματά να λειτουργεί αμέσως. Λαμβάνετε email όταν ένα κλειδί ανακαλείται.

Οι περιορισμοί ιστότοπων αντιγράφονται στο νέο κλειδί. Μπορείτε να δημιουργείτε νέο κλειδί περίπου μία φορά το λεπτό.

Περιορίστε το κλειδί στους ιστότοπούς σας#

Μόνο οι ιστότοποι αυτής της λίστας μπορούν να χρησιμοποιούν το κλειδί σας σε πρόγραμμα περιήγησης: οι ενσωματωμένοι χάρτες και τα αιτήματα από σελίδες σε οποιονδήποτε άλλο ιστότοπο απορρίπτονται. Οι κλήσεις από διακομιστή δεν επηρεάζονται.

1. Στο Περιορισμοί ιστοτόπων, πληκτρολογήστε τον ιστότοπό σας στο Εισαγάγετε έναν ιστότοπο ή τομέα: έναν τομέα όπως example.com, μια διεύθυνση IP ή το localhost. Μπορείτε να επικολλήσετε μια πλήρη διεύθυνση: κρατιέται μόνο το όνομα του ιστότοπου, χωρίς το https://, τη διαδρομή ή τη θύρα.
2. Πατήστε addΠροσθήκη.

Ένας τομέας καλύπτει και τους υποτομείς του: το example.com επιτρέπει το shop.example.com. Πατήστε delete_outline για να αφαιρέσετε έναν ιστότοπο και επιβεβαιώστε· μετά τον τελευταίο, το κλειδί λειτουργεί από οποιονδήποτε ιστότοπο. Λαμβάνετε email κάθε φορά που αφαιρείται ένας ιστότοπος από ένα κλειδί.

Η λίστα ισχύει για προγράμματα περιήγησης. Ένας ενσωματωμένος χάρτης ανοίγει μόνο σε σελίδα ενός ιστότοπου της λίστας· όταν το πρόγραμμα περιήγησης δεν λέει σε ποια σελίδα βρίσκεται, απορρίπτεται. Ένα αίτημα REST API που στέλνεται από μια ιστοσελίδα πρέπει να προέρχεται από ιστότοπο της λίστας. Ένα αίτημα από τον δικό σας διακομιστή δεν δηλώνει ιστότοπο και δεν ελέγχεται. Το ίδιο το Measure Map Online επιτρέπεται πάντα, ώστε οι προεπισκοπήσεις σε αυτή τη σελίδα να συνεχίζουν να λειτουργούν.

Δείτε πώς χρησιμοποιείται το κλειδί#

Η Χρήση αθροίζει όλα τα live κλειδιά σας, ώστε τα στοιχεία να συνεχίζονται όταν αντικαθιστάτε ένα κλειδί. Δείχνει τα αιτήματα των τελευταίων 30 ημερών, τόσο από ενσωματωμένους χάρτες όσο και από το REST API, με μια μπάρα για κάθε ημέρα· το σύνολο Συνολικά· την Τελευταία πρόσβαση· πότε δημιουργήθηκε το τρέχον κλειδί (Το κλειδί δημιουργήθηκε)· και τα Κορυφαία domain: τους ιστότοπους που χρησιμοποιούν τα κλειδιά σας περισσότερο. Ένας ιστότοπος που δεν αναγνωρίζετε εκεί είναι λόγος να περιορίσετε ή να αντικαταστήσετε το κλειδί.

Τα αιτήματα sandbox δεν προσμετρώνται, οπότε τα στοιχεία εμφανίζονται μόνο στο Παραγωγή. Ούτε προσμετρώνται τα αιτήματα που κάνει η ίδια αυτή η σελίδα, στο terminalΔοκιμάστε το API και στις προεπισκοπήσεις.

Κρατήστε το κλειδί σας ασφαλές#

• Δώστε σε κάθε κλειδί μόνο την πρόσβαση που χρειάζεται. Ένα κλειδί μέσα σε ιστοσελίδα (για παράδειγμα στη διεύθυνση μιας ενσωμάτωσης) πρέπει να έχει μόνο Ενσωματωμένοι χάρτες.
• Αυτό το κλειδί μπορεί να αλλάξει τα δεδομένα σας. Κρατήστε το στον διακομιστή σας, ποτέ σε ιστοσελίδα ή εφαρμογή.
• Περιορίστε ένα κλειδί που χρησιμοποιείται σε ιστοσελίδες στους δικούς σας ιστότοπους.
• Αφήστε το κλειδί κρυμμένο στη σελίδα όταν μοιράζεστε την οθόνη σας· για να το αντιγράψετε δεν χρειάζεται να είναι ορατό.
• Αν ένα κλειδί μπορεί να έχει διαρρεύσει, δημιουργήστε νέο και ανακαλέστε αμέσως το παλιό στα Προηγούμενα κλειδιά.
• Αναπτύξτε και δοκιμάστε με κλειδί Sandbox, ώστε τα πειράματα να μην καταλήγουν ανάμεσα στα πραγματικά σας έργα.