Claus d'API · Ajuda de Measure Map Online

Crea la clau que connecta el teu lloc web o programari a Measure Map Online, tria què pot fer, manté separats el treball real i el de proves, i substitueix-la o restringeix-la amb seguretat.

Una clau d'API permet que el teu lloc web o programari treballi amb el teu compte de Measure Map Online: mostrar el mapa d'un projecte al teu lloc, iniciar projectes per als teus visitants, o llegir i canviar projectes amb l'API REST. Crees i gestiones les claus a la pàgina Desenvolupador.

Obre la pàgina Desenvolupador#

Al menú del tauler de control, a Avançat, prem Desenvolupador. S'obre a Claus d'API, i les altres seccions apareixen a sota al menú (en un telèfon, com a pestanyes a la part superior de la pàgina):

Enllaç de convidat (Open Guest): l'enllaç sense codi per al teu lloc web. Consulta Open Guest.
Prova l'API, Webhooks i REST API: consulta la referència de l'API.
Incrusta un mapa (Enterprise): consulta l'API d'iFrame.
Projectes privats (Enterprise): mostra els projectes privats dels clients als teus mapes incrustats. Consulta projectes privats dels clients.

La insígnia a la part superior de la targeta de la clau diu si la clau és Activa, No activada (encara no hi ha cap clau), Desactivat (accés a l'API suspès: cap clau no funciona i no se n'ha de crear de nova fins que el suport ho aixequi) o Expirada (la subscripció no és activa).

La secció Claus d'API amb una clau Sandbox, oculta tret dels extrems, el que pot fer, els botons per mostrar-la i copiar-la i Generar clau nova

Live i Sandbox#

A la part superior de la targeta de la clau, canvia entre Producció i Sandbox. Cadascun té la seva pròpia clau, i la pàgina mostra la que triïs. L'elecció també s'aplica a Prova l'API i es manté mentre vas d'una secció a l'altra. Incrusta un mapa i Enllaç de convidat fan servir sempre la teva clau real, perquè els visitants del teu lloc web només poden obrir projectes reals: en obrir-ne qualsevol, la pàgina torna a Producció.

Producció és el teu compte real, i la pàgina s'hi obre. Fes servir una clau real al teu lloc web.
Sandbox és per crear i provar una integració. Els projectes, les carpetes i els productes fets amb una clau sandbox es mantenen separats dels reals: una clau real no els pot veure, i una clau sandbox no pot veure els reals. Les peticions fetes amb una clau sandbox no es compten a les xifres d'ús, i els projectes de convidat creats amb una no es facturen mai.

Crear una clau sandbox nova no afecta mai la clau real, ni al revés.

Tria què pot fer la clau#

Quan crees una clau, el diàleg llista cada àrea de l'API a Accés per a la clau nova. Tria fins on arriba la clau nova a cadascuna:

Àrea	Opcions	Què permet
Mapes incrustats (Enterprise)	Sense accés, Permès	Inicia la sessió d'un espectador en un mapa incrustat. La majoria d'integracions només necessiten això.
Projectes de convidats (Open Guest)	Sense accés, Permès	Inicia un projecte de convidat per a un visitant, amb un token del teu servidor. La majoria d'integracions només necessiten això.
Projectes	Sense accés, Lectura, Lectura i canvis	Projectes i carpetes, amb les seves mesures, comentaris i exportacions.
Usuaris (Enterprise)	Sense accés, Lectura, Lectura i canvis	Els usuaris de la teva organització, les seves invitacions, llicències i equips.
Organització (Enterprise)	Sense accés, Lectura, Lectura i canvis	El perfil, la política, l'inici de sessió únic i el registre d'activitat de la teva organització, i les seves llicències.
Productes	Sense accés, Lectura, Lectura i canvis	El teu catàleg de productes i els seus preus.
Convidats (Open Guest)	Sense accés, Lectura, Lectura i canvis	El teu enllaç de convidat, els projectes de convidat i les sol·licituds de pressupost, amb les dades de contacte dels teus convidats, i el teu límit de despesa.
Compte	Sense accés, Lectura, Lectura i canvis	El teu pla, les llicències, l'ús de l'API, el perfil i la configuració del correu, i, a Open Guest, la teva despesa i pressupost.
Desenvolupador	Sense accés, Lectura, Lectura i canvis	Les teves claus d'API i el webhook. Una clau mai va més enllà del seu propi accés.
Clients (Partner)	Sense accés, Lectura, Lectura i canvis	Els teus clients, els plans que pagues per a ells, les seves invitacions i factures.

El diàleg només mostra les àrees que inclou el teu pla. Posa el punter sobre una opció per veure exactament què concedeix. La teva primera clau comença només amb Mapes incrustats, que és tot el que necessita un mapa incrustat; una clau que en substitueix una altra comença amb l'accés d'aquella. Tria almenys una àrea.

Què pot fer una clau es fixa quan la crees. Per donar a una clau més o menys accés, en crees una de nova.

Crea una clau#

Tria Producció o Sandbox a la part superior de la targeta de la clau.
Prem Genera una clau nova. S'obre un diàleg, amb Producció o Sandbox al costat del títol.
Defineix l'accés a Accés per a la clau nova (consulta més amunt).
Si vols, escriu un nom a Nom de la clau nova (opcional), per distingir les claus.
Prem Crea.

El diàleg Generar clau nova: l'entorn Live, l'accés a cada àrea de l'API i el nom de la clau

Aleshores el diàleg diu La teva clau nova és a punt. Pots tornar-la a copiar des d'aquesta pàgina en qualsevol moment. Mostra la clau, oculta tret dels primers i els darrers caràcters, i què pot Pot fer. Prem per mostrar-la sencera, o per copiar tota la clau, i després prem Fet. La targeta de la clau la mostra de la mateixa manera a La teva clau d'API. Reps un correu cada vegada que es crea una clau al teu compte.

Claus fetes abans de la configuració d'accés#

Una clau feta abans que les claus tinguessin configuració d'accés pot fer tot excepte treballar amb productes. Aquestes claus es van retirant: la targeta de la clau diu quan deixa de funcionar la teva, i també reps una notificació. Prem Genera una clau nova, que la targeta mostra aleshores com a botó principal, i substitueix la clau antiga al teu lloc web o servidor abans d'aquesta data. El diàleg comença només amb Mapes incrustats, així que tria'n més si el teu servidor ho necessita.

Substitueix una clau#

Torna a prémer Genera una clau nova quan ja tens una clau, i crea la nova al diàleg. El diàleg diu què passa amb la clau actual: Es crearà una clau nova i la clau actual continuarà funcionant durant 24 hores, perquè puguis actualitzar els llocs que l'utilitzen. La podràs revocar abans quan hagis acabat. Una clau feta abans de la configuració d'accés continua funcionant fins a la data que se't va donar.

La clau antiga passa a Claus anteriors, amb el temps que li queda, quan es va fer servir per última vegada i què pot fer. Encara s'accepten mentre desplegues la clau nova. Revoca'n una tan bon punt no la faci servir res. Per aturar-la a l'instant, prem Revoca i confirma; qualsevol lloc que encara la faci servir deixa de funcionar immediatament. Reps un correu quan es revoca una clau.

Les restriccions dels llocs web es copien a la clau nova. Pots crear una clau nova aproximadament un cop per minut.

Una clau anterior que encara s'accepta unes hores més, amb el botó Revocar

Restringeix la clau als teus llocs web#

Només els llocs web d'aquesta llista poden utilitzar la teva clau en un navegador: els mapes incrustats i les sol·licituds de pàgines de qualsevol altre lloc es rebutgen. Les crides des d'un servidor no es veuen afectades.

A Restriccions de llocs web, escriu el teu lloc a Introdueix un lloc web o domini: un domini com example.com, una adreça IP o localhost. Pots enganxar una adreça completa: només es manté el nom del lloc, sense https://, el camí ni el port.
Prem Afegeix.

Un domini també cobreix els seus subdominis: example.com permet shop.example.com. Prem per treure un lloc, i confirma; després de l'últim, la clau funciona des de qualsevol lloc web. Reps un correu cada vegada que es treu un lloc web d'una clau.

La llista s'aplica als navegadors. Un mapa incrustat només s'obre en una pàgina d'un lloc web de la llista; quan el navegador no diu en quina pàgina és, es rebutja. Una petició de l'API REST enviada des d'una pàgina web ha de venir d'un lloc web de la llista. Una petició des del teu propi servidor no esmenta cap lloc web i no es comprova. El mateix Measure Map Online sempre està permès, de manera que les previsualitzacions d'aquesta pàgina continuen funcionant.

Restriccions de llocs web amb dos dominis permesos

Mira com es fa servir la clau#

Ús suma totes les teves claus reals, de manera que les xifres continuen quan substitueixes una clau. Mostra les peticions dels darrers 30 dies, tant de mapes incrustats com de l'API REST, amb una barra per a cada dia; el total Tot el temps; l'Darrer accés; quan es va crear la clau actual (Clau creada); i els Dominis principals: els llocs web que més fan servir les teves claus. Un lloc web que no reconeguis aquí és un motiu per restringir o substituir la clau.

Les peticions sandbox no es compten, així que les xifres només es mostren a Producció. Tampoc no es compten les peticions que fa aquesta mateixa pàgina, a Prova l'API i a les previsualitzacions.

Mantén la clau segura#

Dona a cada clau només l'accés que necessita. Una clau en una pàgina web (per exemple a l'adreça d'un mapa incrustat) hauria de tenir només Mapes incrustats.
Aquesta clau pot canviar les teves dades. Guarda-la al teu servidor, mai en una pàgina web ni en una aplicació.
Restringeix una clau que es fa servir en pàgines web als teus propis llocs web.
Deixa la clau oculta a la pàgina quan comparteixes la pantalla; copiar-la no necessita mai que es vegi.
Si una clau pot haver-se filtrat, crea'n una de nova i revoca l'antiga a Claus anteriors de seguida.
Crea i prova amb una clau Sandbox, perquè els experiments no vagin a parar mai entre els teus projectes reals.