API-nycklar
Skapa nyckeln som kopplar din webbplats eller programvara till Measure Map Online, välj vad den får göra, håll live- och testarbete åtskilda och byt ut eller begränsa den på ett säkert sätt.
Med en API-nyckel kan din egen webbplats eller programvara arbeta med ditt Measure Map Online-konto: visa ett projekts karta på din webbplats, starta projekt åt dina besökare eller läsa och ändra projekt via REST-API:t. Du skapar och hanterar nycklar på sidan Utvecklare.
Öppna utvecklarsidan#
I instrumentpanelens meny, under Avancerat, trycker du på Utvecklare. Den öppnas på API-nycklar, och övriga avsnitt finns listade under den i menyn (på en mobil som flikar högst upp på sidan):
- Gästlänk (Open Guest): länken utan kod för din webbplats. Se Open Guest.
- Testa API:t, Webhooks och REST API: se API-referensen.
- Bädda in en karta (Enterprise): se iFrame-API:t.
- Privata projekt (Enterprise): visa kunders privata projekt i dina inbäddningar. Se kunders privata projekt.
Märket högst upp på nyckelkortet visar om din nyckel är Aktiv, Inte aktiverad (ingen nyckel än), Inaktiverad (API-åtkomsten är avstängd: ingen nyckel fungerar och ingen ny kan skapas förrän supporten häver det) eller Utgången (prenumerationen är inte aktiv).
Live och Sandbox#
Högst upp på nyckelkortet växlar du mellan Live och Sandbox. Var och en har sin egen nyckel, och sidan visar den du väljer. Valet gäller också i Testa API:t och finns kvar när du går mellan avsnitten. Bädda in en karta och Gästlänk använder alltid din livenyckel, eftersom besökare på din webbplats bara kan öppna liveprojekt: när du öppnar något av dem växlar sidan tillbaka till Live.
- Live är ditt riktiga konto, och sidan öppnas på det. Använd en livenyckel på din webbplats.
- Sandbox är till för att bygga och testa en integration. Projekt, mappar och produkter som skapas med en sandbox-nyckel hålls åtskilda från dina riktiga: en livenyckel kan inte se dem, och en sandbox-nyckel kan inte se dina liveprojekt. Förfrågningar med en sandbox-nyckel räknas inte i din användningsstatistik, och gästprojekt som skapas med en faktureras aldrig.
Att skapa en ny sandbox-nyckel påverkar aldrig din livenyckel, och tvärtom.
Välj vad nyckeln får göra#
När du skapar en nyckel listar dialogrutan varje område i API:t under Åtkomst för den nya nyckeln. Välj hur långt den nya nyckeln når inom varje område:
| Område | Val | Vad det tillåter |
|---|---|---|
| Inbäddade kartor (Enterprise) | Ingen åtkomst, Tillåten | Logga in en besökare på en inbäddad karta. De flesta integrationer behöver bara detta. |
| Gästprojekt (Open Guest) | Ingen åtkomst, Tillåten | Starta ett gästprojekt för en besökare, med en token från din server. De flesta integrationer behöver bara detta. |
| Projekt | Ingen åtkomst, Läsa, Läsa och ändra | Projekt och mappar, med deras mätningar, kommentarer och exporter. |
| Användare (Enterprise) | Ingen åtkomst, Läsa, Läsa och ändra | Användarna i din organisation, deras inbjudningar, licenser och team. |
| Organisation (Enterprise) | Ingen åtkomst, Läsa, Läsa och ändra | Din organisations profil, policy, single sign-on och aktivitetslogg, samt dess licenser. |
| Produkter | Ingen åtkomst, Läsa, Läsa och ändra | Din produktkatalog och dess priser. |
| Gäster (Open Guest) | Ingen åtkomst, Läsa, Läsa och ändra | Din gästlänk, gästprojekt och offertförfrågningar, med dina gästers kontaktuppgifter, och din budget. |
| Konto | Ingen åtkomst, Läsa, Läsa och ändra | Din plan, licenser, API-användning, profil och e-postinställningar, och med Open Guest dina utgifter och din budget. |
| Utvecklare | Ingen åtkomst, Läsa, Läsa och ändra | Dina API-nycklar och din webhook. En nyckel når aldrig längre än sin egen åtkomst. |
| Kunder (Partner) | Ingen åtkomst, Läsa, Läsa och ändra | Dina kunder, planerna du betalar för dem, deras inbjudningar och fakturor. |
Dialogrutan visar bara de områden som din plan omfattar. Håll pekaren över ett val för att se exakt vad det ger. Din första nyckel börjar med bara Inbäddade kartor, vilket är allt en inbäddad karta behöver; en nyckel som ersätter en annan börjar med den nyckelns åtkomst. Välj minst ett område.
Vad en nyckel får göra bestäms när du skapar den. Vill du ge en nyckel mer eller mindre åtkomst skapar du en ny.
Skapa en nyckel#
- Välj Live eller Sandbox högst upp på nyckelkortet.
- Tryck på Skapa ny nyckel. En dialogruta öppnas, med Live eller Sandbox bredvid titeln.
- Ange åtkomsten under Åtkomst för den nya nyckeln (se ovan).
- Om du vill skriver du ett namn i Namn på den nya nyckeln (valfritt), för att skilja dina nycklar åt.
- Tryck på Skapa.
Dialogrutan säger sedan Din nya nyckel är klar. Du kan kopiera den igen från den här sidan när som helst. Den visar nyckeln, dold utom de första och sista tecknen, och vad den Kan göra. Tryck på för att visa den i sin helhet, eller på för att kopiera hela nyckeln, och tryck sedan på Klar. Nyckelkortet visar den på samma sätt under Din API-nyckel. Du får ett e-postmeddelande varje gång en nyckel skapas på ditt konto.
Nycklar som skapades före åtkomstinställningarna#
En nyckel som skapades innan nycklar hade åtkomstinställningar kan göra allt utom att arbeta med produkter. Sådana nycklar fasas ut: nyckelkortet anger när din slutar fungera, och du får också en avisering. Tryck på Skapa ny nyckel, som kortet då visar som huvudknapp, och byt ut den gamla nyckeln på din webbplats eller server före det datumet. Dialogrutan börjar med bara Inbäddade kartor, så välj fler om din server behöver det.
Byt ut en nyckel#
Tryck på Skapa ny nyckel igen när du har en nyckel och skapa den nya i dialogrutan. Dialogrutan säger vad som händer med den nuvarande nyckeln: En ny nyckel skapas och din nuvarande nyckel fortsätter fungera i 24 timmar, så att du kan uppdatera de webbplatser som använder den. Du kan återkalla den tidigare när du är klar. En nyckel som skapades före åtkomstinställningarna fortsätter i stället fungera till det datum du fick.
Den gamla nyckeln flyttas till Tidigare nycklar, med tiden den har kvar, när den senast användes och vad den kan göra. Accepteras fortfarande medan du rullar ut den nya nyckeln. Återkalla en så snart ingenting använder den. För att stoppa den direkt trycker du på Återkalla och bekräftar; varje webbplats som fortfarande använder den slutar fungera omedelbart. Du får ett e-postmeddelande när en nyckel återkallas.
Dina webbplatsbegränsningar kopieras till den nya nyckeln. Du kan skapa en ny nyckel ungefär en gång i minuten.
Begränsa nyckeln till dina webbplatser#
Bara webbplatserna i den här listan kan använda din nyckel i en webbläsare: inbäddade kartor och förfrågningar från sidor på andra webbplatser nekas. Anrop från en server påverkas inte.
- Under Webbplatsbegränsningar skriver du din webbplats i
Ange en webbplats eller domän: en domän som
example.com, en IP-adress ellerlocalhost. Du kan klistra in en hel adress: bara webbplatsens namn behålls, utanhttps://, sökvägen eller porten. - Tryck på Lägg till.
En domän omfattar också sina underdomäner: example.com tillåter
shop.example.com. Tryck på för att ta bort en
webbplats och bekräfta; efter den sista fungerar nyckeln från vilken
webbplats som helst. Du får ett e-postmeddelande varje gång en webbplats tas
bort från en nyckel.
Listan gäller webbläsare. En inbäddad karta öppnas bara på en sida på en listad webbplats; när webbläsaren inte anger vilken sida den är på avvisas den. En REST-API-förfrågan som skickas från en webbsida måste komma från en listad webbplats. En förfrågan från din egen server anger ingen webbplats och kontrolleras inte. Measure Map Online självt är alltid tillåtet, så förhandsvisningarna på den här sidan fortsätter fungera.
Se hur nyckeln används#
Användning summerar alla dina livenycklar, så siffrorna fortsätter när du byter ut en nyckel. Den visar förfrågningarna de senaste 30 dagarna, från både inbäddade kartor och REST-API:t, med en stapel för varje dag; totalen Totalt; Senaste åtkomst; när den nuvarande nyckeln skapades (Nyckel skapad); och Vanligaste domäner: de webbplatser som använder dina nycklar mest. En webbplats du inte känner igen där är ett skäl att begränsa eller byta ut nyckeln.
Sandbox-förfrågningar räknas inte, så siffrorna visas bara i Live. Inte heller de förfrågningar som den här sidan gör själv, i Testa API:t och förhandsvisningarna, räknas.
Håll din nyckel säker#
- Ge varje nyckel bara den åtkomst den behöver. En nyckel i en webbsida (till exempel i en inbäddnings adress) bör bara ha Inbäddade kartor.
- Den här nyckeln kan ändra dina data. Förvara den på din server, aldrig på en webbsida eller i en app.
- Begränsa en nyckel som används i webbsidor till dina egna webbplatser.
- Låt nyckeln vara dold på sidan när du delar din skärm; att kopiera den kräver aldrig att den visas.
- Om en nyckel kan ha läckt skapar du en ny och återkallar genast den gamla under Tidigare nycklar.
- Bygg och testa med en Sandbox-nyckel, så att experiment aldrig hamnar bland dina riktiga projekt.
Behöver du mer hjälp?
Skriv till vårt supportteam och berätta vad du försökte göra. Skärmdumpar hjälper.