Chiavi API
Crea la chiave che collega il tuo sito web o il tuo software a Measure Map Online, scegli cosa può fare, tieni separati lavoro reale e di prova, e sostituiscila o limitala in sicurezza.
Una chiave API permette al tuo sito web o al tuo software di lavorare con il tuo account Measure Map Online: mostrare sul tuo sito la mappa di un progetto, avviare progetti per i tuoi visitatori, oppure leggere e modificare i progetti tramite l'API REST. Crei e gestisci le chiavi nella pagina Sviluppatori.
Aprire la pagina Sviluppatori#
Nel menu della dashboard, sotto Avanzate, premi Sviluppatori. Si apre su Chiavi API, e le altre sezioni sono elencate sotto nel menu (su un telefono, come schede in cima alla pagina):
- Link per ospiti (Open Guest): il link senza codice per il tuo sito web. Vedi Open Guest.
- Prova l'API, Webhook e REST API: vedi il riferimento API.
- Incorpora una mappa (Enterprise): vedi la API iFrame.
- Progetti privati (Enterprise): mostra i progetti privati dei clienti nelle tue mappe incorporate. Vedi i progetti privati dei clienti.
Il badge in cima alla scheda della chiave indica se la tua chiave è Attivo, Non attivato (ancora nessuna chiave), Disattivato (accesso API sospeso: nessuna chiave funziona e non se ne può creare una nuova finché il supporto non lo ripristina) oppure Scaduto (l'abbonamento non è attivo).
Live e Sandbox#
In cima alla scheda della chiave, passa da Produzione a Sandbox. Ognuno ha la propria chiave, e la pagina mostra quella che scegli. La scelta vale anche in Prova l'API e resta mentre ti sposti tra le sezioni. Incorpora una mappa e Link per ospiti usano sempre la tua chiave live, perché i visitatori del tuo sito web possono aprire solo progetti live: aprendo una delle due, la pagina torna su Produzione.
- Produzione è il tuo account reale, e la pagina si apre su di esso. Usa una chiave live sul tuo sito web.
- Sandbox serve a creare e provare un'integrazione. Progetti, cartelle e prodotti creati con una chiave sandbox sono tenuti separati da quelli reali: una chiave live non può vederli, e una chiave sandbox non può vedere quelli live. Le richieste fatte con una chiave sandbox non rientrano nei dati di utilizzo, e i progetti ospite creati con una di esse non vengono mai fatturati.
Creare una nuova chiave sandbox non influisce mai sulla tua chiave live, e viceversa.
Scegliere cosa può fare la chiave#
Quando crei una chiave, la finestra elenca ogni area dell'API in Accesso per la nuova chiave. Scegli fino a dove la nuova chiave si spinge in ciascuna:
| Area | Scelte | Cosa consente |
|---|---|---|
| Mappe incorporate (Enterprise) | Nessun accesso, Consentito | Fa accedere un visitatore a una mappa incorporata. La maggior parte delle integrazioni ha bisogno solo di questo. |
| Progetti degli ospiti (Open Guest) | Nessun accesso, Consentito | Avvia un progetto ospite per un visitatore, con un token dal tuo server. La maggior parte delle integrazioni ha bisogno solo di questo. |
| Progetti | Nessun accesso, Lettura, Lettura e modifica | Progetti e cartelle, con le loro misurazioni, commenti ed esportazioni. |
| Utenti (Enterprise) | Nessun accesso, Lettura, Lettura e modifica | Gli utenti della tua organizzazione, i loro inviti, licenze e team. |
| Organizzazione (Enterprise) | Nessun accesso, Lettura, Lettura e modifica | Il profilo, i criteri, il single sign-on e il registro attività della tua organizzazione, e le sue licenze. |
| Prodotti | Nessun accesso, Lettura, Lettura e modifica | Il tuo catalogo prodotti e i relativi prezzi. |
| Ospiti (Open Guest) | Nessun accesso, Lettura, Lettura e modifica | Il tuo link per ospiti, i progetti degli ospiti e le richieste di preventivo, con i dati di contatto dei tuoi ospiti, e il tuo budget. |
| Account | Nessun accesso, Lettura, Lettura e modifica | Il tuo piano, le licenze, l'uso dell'API, il profilo e le impostazioni email e, su Open Guest, la tua spesa e il budget. |
| Sviluppatori | Nessun accesso, Lettura, Lettura e modifica | Le tue chiavi API e il webhook. Una chiave non va mai oltre il proprio accesso. |
| Clienti (Partner) | Nessun accesso, Lettura, Lettura e modifica | I tuoi clienti, i piani che paghi per loro, i loro inviti e le fatture. |
La finestra mostra solo le aree incluse nel tuo piano. Tieni il puntatore su una scelta per vedere esattamente cosa concede. La tua prima chiave parte con la sola Mappe incorporate, che è tutto ciò che serve a una mappa incorporata; una chiave che ne sostituisce un'altra parte con gli accessi di quella. Scegli almeno un'area.
Cosa può fare una chiave si stabilisce quando la crei. Per darle più o meno accesso, creane una nuova.
Creare una chiave#
- Scegli Produzione oppure Sandbox in cima alla scheda della chiave.
- Premi Genera nuova chiave. Si apre una finestra, con Produzione o Sandbox accanto al titolo.
- Imposta l'accesso in Accesso per la nuova chiave (vedi sopra).
- Se vuoi, scrivi un nome in Nome per la nuova chiave (facoltativo), per distinguere le chiavi.
- Premi Crea.
La finestra poi indica La tua nuova chiave è pronta. Puoi copiarla di nuovo da questa pagina in qualsiasi momento. Mostra la chiave, nascosta tranne il primo e l'ultimo carattere, e cosa Può fare. Premi per mostrarla per intero, oppure per copiare tutta la chiave, poi premi Fatto. La scheda della chiave la mostra allo stesso modo in La tua chiave API. Ricevi un'email ogni volta che viene creata una chiave sul tuo account.
Chiavi create prima delle impostazioni di accesso#
Una chiave creata prima che le chiavi avessero impostazioni di accesso può fare tutto tranne lavorare con i prodotti. Queste chiavi stanno per essere ritirate: la scheda della chiave indica quando smetterà di funzionare la tua, e ricevi anche una notifica. Premi Genera nuova chiave, che la scheda mostra allora come pulsante principale, e sostituisci la vecchia chiave sul tuo sito web o server prima di quella data. La finestra parte dalla sola Mappe incorporate, quindi scegli di più se il tuo server ne ha bisogno.
Sostituire una chiave#
Premi di nuovo Genera nuova chiave quando hai già una chiave, e crea quella nuova nella finestra. La finestra spiega cosa succede alla chiave attuale: Verrà creata una nuova chiave e quella attuale continuerà a funzionare per 24 ore, così potrai aggiornare i siti che la usano. Potrai revocarla prima, quando hai finito. Una chiave creata prima delle impostazioni di accesso continua invece a funzionare fino alla data che ti è stata indicata.
La vecchia chiave passa in Chiavi precedenti, con il tempo che le resta, quando è stata usata l'ultima volta e cosa può fare. Ancora accettate mentre distribuisci la nuova chiave. Revoca una chiave appena nulla la usa più. Per fermarla subito, premi Revoca e conferma; qualsiasi sito che la usi ancora smette di funzionare immediatamente. Ricevi un'email quando una chiave viene revocata.
Le restrizioni dei tuoi siti web vengono copiate sulla nuova chiave. Puoi creare una nuova chiave circa una volta al minuto.
Limitare la chiave ai tuoi siti web#
Solo i siti web di questo elenco possono usare la tua chiave in un browser: le mappe incorporate e le richieste da pagine di qualsiasi altro sito vengono rifiutate. Le chiamate da un server non sono interessate.
- In Restrizioni sui siti web, scrivi il tuo sito in
Inserisci un sito web o un dominio: un dominio come
example.com, un indirizzo IP olocalhost. Puoi incollare un indirizzo completo: viene conservato solo il nome del sito, senzahttps://, percorso o porta. - Premi Aggiungi.
Un dominio copre anche i suoi sottodomini: example.com consente
shop.example.com. Premi per rimuovere un sito e conferma;
dopo l'ultimo, la chiave funziona da qualsiasi sito web. Ricevi un'email ogni
volta che un sito web viene rimosso da una chiave.
L'elenco vale per i browser. Una mappa incorporata si apre solo su una pagina di un sito web in elenco; quando il browser non dice su quale pagina si trova, viene rifiutata. Una richiesta API REST inviata da una pagina web deve arrivare da un sito web in elenco. Una richiesta dal tuo server non indica alcun sito web e non viene controllata. Measure Map Online stesso è sempre consentito, così le anteprime in questa pagina continuano a funzionare.
Vedere come viene usata la chiave#
Utilizzo somma tutte le tue chiavi live, così i dati proseguono quando sostituisci una chiave. Mostra le richieste degli ultimi 30 giorni, sia delle mappe incorporate sia dell'API REST, con una barra per ogni giorno; il totale Sempre; l'Ultimo accesso; quando è stata creata la chiave attuale (Chiave creata); e i Domini principali: i siti web che usano di più le tue chiavi. Un sito web che non riconosci è un motivo per limitare o sostituire la chiave.
Le richieste sandbox non vengono contate, quindi i dati compaiono solo in Produzione. Non vengono contate nemmeno le richieste che fa questa stessa pagina, in Prova l'API e nelle anteprime.
Tenere al sicuro la chiave#
- Dai a ogni chiave solo l'accesso che le serve. Una chiave in una pagina web (per esempio nell'indirizzo di una mappa incorporata) dovrebbe avere solo Mappe incorporate.
- Questa chiave può modificare i tuoi dati. Tienila sul tuo server, mai in una pagina web o in un'app.
- Limita ai tuoi siti web una chiave usata nelle pagine web.
- Lascia la chiave nascosta nella pagina quando condividi lo schermo; per copiarla non serve mostrarla.
- Se una chiave potrebbe essere trapelata, creane una nuova e revoca subito la vecchia in Chiavi precedenti.
- Sviluppa e prova con una chiave Sandbox, così gli esperimenti non finiscono mai tra i tuoi progetti reali.
Hai ancora bisogno di aiuto?
Scrivi al nostro team di supporto e raccontaci cosa stavi cercando di fare. Gli screenshot aiutano.