API-nøkler
Opprett nøkkelen som kobler nettstedet eller programvaren din til Measure Map Online, velg hva den kan gjøre, hold live- og testarbeid adskilt, og bytt den ut eller begrens den på en trygg måte.
En API-nøkkel lar ditt eget nettsted eller din egen programvare arbeide med Measure Map Online-kontoen din: vise et prosjekts kart på nettstedet, opprette prosjekter for besøkende, eller lese og endre prosjekter gjennom REST API-et. Du oppretter og administrerer nøkler på siden Utvikler.
Åpne siden Utvikler#
I dashbordmenyen, under Avansert, trykker du Utvikler. Den åpnes på API-nøkler, og de andre delene står under den i menyen (på en telefon som faner øverst på siden):
- Gjestelenke (Open Guest): lenken uten kode for nettstedet ditt. Se Open Guest.
- Prøv API-et, Webhooks og REST API: se API-referansen.
- Bygg inn et kart (Enterprise): se iFrame API.
- Private prosjekter (Enterprise): vis kunders private prosjekter i innbyggingene dine. Se kunders private prosjekter.
Merket øverst på nøkkelkortet viser om nøkkelen din er Aktiv, Ikke aktivert (ingen nøkkel ennå), Deaktivert (API-tilgangen er suspendert: ingen nøkkel fungerer og ingen ny kan opprettes før brukerstøtten opphever det) eller Utløpt (abonnementet er ikke aktivt).
Live og Sandbox#
Øverst på nøkkelkortet bytter du mellom Live og Sandbox. Hver har sin egen nøkkel, og siden viser den du velger. Valget gjelder også i Prøv API-et, og det blir stående mens du går mellom delene. Bygg inn et kart og Gjestelenke bruker alltid live-nøkkelen din, fordi besøkende på nettstedet ditt bare kan åpne live-prosjekter: å åpne en av dem bytter siden tilbake til Live.
- Live er den virkelige kontoen din, og siden åpnes på den. Bruk en live-nøkkel på nettstedet ditt.
- Sandbox er for å bygge og teste en integrasjon. Prosjekter, mapper og produkter laget med en sandbox-nøkkel holdes adskilt fra de virkelige: en live-nøkkel kan ikke se dem, og en sandbox-nøkkel kan ikke se live-prosjektene dine. Forespørsler med en sandbox-nøkkel telles ikke i bruksoversikten din, og gjesteprosjekter laget med en faktureres aldri.
Å lage en ny sandbox-nøkkel påvirker aldri live-nøkkelen din, og omvendt.
Velg hva nøkkelen kan gjøre#
Når du oppretter en nøkkel, viser dialogen hvert område av API-et under Tilgang for den nye nøkkelen. Velg hvor langt den nye nøkkelen rekker inn i hvert av dem:
| Område | Valg | Hva det tillater |
|---|---|---|
| Innebygde kart (Enterprise) | Ingen tilgang, Tillatt | Logg en seer på et innbygd kart. De fleste integrasjoner trenger bare dette. |
| Gjesteprosjekter (Open Guest) | Ingen tilgang, Tillatt | Start et gjesteprosjekt for en besøkende, med et token fra serveren din. De fleste integrasjoner trenger bare dette. |
| Prosjekter | Ingen tilgang, Lese, Lese og endre | Prosjekter og mapper, med målinger, kommentarer og eksporter. |
| Brukere (Enterprise) | Ingen tilgang, Lese, Lese og endre | Brukerne i organisasjonen din, invitasjonene, lisensene og teamene deres. |
| Organisasjon (Enterprise) | Ingen tilgang, Lese, Lese og endre | Profilen, retningslinjene, single sign-on og aktivitetsloggen til organisasjonen din, og lisensene. |
| Produkter | Ingen tilgang, Lese, Lese og endre | Produktkatalogen din og prisene. |
| Gjester (Open Guest) | Ingen tilgang, Lese, Lese og endre | Gjestelenken din, gjesteprosjekter og tilbudsforespørsler, med kontaktopplysningene til gjestene dine, og budsjettet ditt. |
| Konto | Ingen tilgang, Lese, Lese og endre | Planen, lisensene, API-bruken, profilen og e-postinnstillingene dine, og på Open Guest forbruket og budsjettet ditt. |
| Utvikler | Ingen tilgang, Lese, Lese og endre | API-nøklene og webhooken din. En nøkkel når aldri lenger enn sin egen tilgang. |
| Klienter (Partner) | Ingen tilgang, Lese, Lese og endre | Klientene dine, planene du betaler for dem, invitasjonene og fakturaene deres. |
Dialogen viser bare områdene planen din inneholder. Hold pekeren over et valg for å se nøyaktig hva det gir. Den første nøkkelen din starter med bare Innebygde kart, som er alt et innebygd kart trenger; en nøkkel som erstatter en annen, starter med den nøkkelens tilgang. Velg minst ett område.
Hva en nøkkel kan gjøre, er fastlagt når du oppretter den. For å gi en nøkkel mer eller mindre tilgang oppretter du en ny.
Opprett en nøkkel#
- Velg Live eller Sandbox øverst på nøkkelkortet.
- Trykk Generer ny nøkkel. En dialog åpnes, med Live eller Sandbox ved siden av tittelen.
- Sett tilgangen under Tilgang for den nye nøkkelen (se ovenfor).
- Om du vil, skriver du et navn i Navn på den nye nøkkelen (valgfritt) for å skille nøklene fra hverandre.
- Trykk Opprett.
Dialogen sier deretter Den nye nøkkelen din er klar. Du kan kopiere den igjen fra denne siden når som helst. Den viser nøkkelen, skjult bortsett fra de første og siste tegnene, og hva den Kan gjøre. Trykk for å vise den fullt ut, eller for å kopiere hele nøkkelen, og trykk deretter Ferdig. Nøkkelkortet viser den på samme måte under API-nøkkelen din. Du får en e-post hver gang en nøkkel opprettes på kontoen din.
Nøkler laget før tilgangsinnstillingene#
En nøkkel laget før nøkler hadde tilgangsinnstillinger, kan gjøre alt unntatt å arbeide med produkter. Slike nøkler fases ut: nøkkelkortet sier når din slutter å fungere, og du får også et varsel. Trykk Generer ny nøkkel, som kortet da viser som hovedknapp, og bytt ut den gamle nøkkelen på nettstedet eller serveren din før den datoen. Dialogen starter fra bare Innebygde kart, så velg mer hvis serveren din trenger det.
Bytt ut en nøkkel#
Trykk Generer ny nøkkel igjen når du har en nøkkel, og opprett den nye i dialogen. Dialogen sier hva som skjer med den nåværende nøkkelen: En ny nøkkel opprettes, og den gjeldende nøkkelen fortsetter å fungere i 24 timer, så du kan oppdatere nettstedene som bruker den. Du kan tilbakekalle den tidligere når du er ferdig. En nøkkel laget før tilgangsinnstillingene fortsetter i stedet å fungere til datoen du fikk oppgitt.
Den gamle nøkkelen flyttes til Tidligere nøkler, med tiden den har igjen, når den sist ble brukt og hva den kan gjøre. Godtas fortsatt mens du ruller ut den nye nøkkelen. Tilbakekall en så snart ingenting bruker den. For å stoppe den med en gang trykker du Tilbakekall og bekrefter; alle nettsteder som fortsatt bruker den, slutter å fungere umiddelbart. Du får en e-post når en nøkkel tilbakekalles.
Nettstedsbegrensningene dine kopieres til den nye nøkkelen. Du kan opprette en ny nøkkel omtrent én gang i minuttet.
Begrens nøkkelen til nettstedene dine#
Bare nettstedene på denne listen kan bruke nøkkelen din i en nettleser: innebygde kart og forespørsler fra sider på andre nettsteder avvises. Kall fra en server påvirkes ikke.
- Under Nettstedsbegrensninger skriver du nettstedet ditt i
Skriv inn et nettsted eller domene: et domene som
example.com, en IP-adresse ellerlocalhost. Du kan lime inn en full adresse: bare nettstedets navn beholdes, utenhttps://, stien eller porten. - Trykk Legg til.
Et domene dekker også underdomenene sine: example.com tillater
shop.example.com. Trykk for å fjerne et nettsted, og
bekreft; etter det siste fungerer nøkkelen fra alle nettsteder. Du får en
e-post hver gang et nettsted fjernes fra en nøkkel.
Listen gjelder nettlesere. Et innebygd kart åpnes bare på en side på et nettsted i listen; når nettleseren ikke oppgir hvilken side den er på, nektes det. En REST API-forespørsel sendt fra en nettside må komme fra et nettsted i listen. En forespørsel fra din egen server oppgir ikke noe nettsted og kontrolleres ikke. Measure Map Online selv er alltid tillatt, så forhåndsvisningene på denne siden fortsetter å fungere.
Se hvordan nøkkelen brukes#
Bruk legger sammen alle live-nøklene dine, så tallene fortsetter når du bytter ut en nøkkel. Den viser forespørslene de siste 30 dagene, fra både innebygde kart og REST API-et, med en stolpe for hver dag; totalen Totalt; Siste tilgang; når den nåværende nøkkelen ble opprettet (Nøkkel opprettet); og Mest brukte domener: nettstedene som bruker nøklene dine mest. Et nettsted du ikke kjenner igjen der, er en grunn til å begrense eller bytte ut nøkkelen.
Sandbox-forespørsler telles ikke, så tallene vises bare på Live. Det gjør heller ikke forespørslene denne siden selv sender, i Prøv API-et og forhåndsvisningene.
Hold nøkkelen din trygg#
- Gi hver nøkkel bare den tilgangen den trenger. En nøkkel på en nettside (for eksempel i adressen til en innbygging) bør bare ha Innebygde kart.
- Denne nøkkelen kan endre dataene dine. Hold den på serveren din, aldri på en nettside eller i en app.
- Begrens en nøkkel som brukes på nettsider, til dine egne nettsteder.
- La nøkkelen være skjult på siden når du deler skjermen; å kopiere den krever aldri at den vises.
- Hvis en nøkkel kan ha lekket, oppretter du en ny og tilbakekaller den gamle under Tidligere nøkler med en gang.
- Bygg og test med en Sandbox-nøkkel, så eksperimenter aldri havner blant de virkelige prosjektene dine.
Trenger du mer hjelp?
Skriv til brukerstøtten og fortell hva du prøvde å gjøre. Skjermbilder hjelper.