API-sleutels
Maak de sleutel die je website of software met Measure Map Online verbindt, kies wat hij mag doen, houd live- en testwerk gescheiden en vervang of beperk hem veilig.
Met een API-sleutel kunnen je eigen website of software met je Measure Map Online-account werken: de kaart van een project op je site tonen, projecten starten voor je bezoekers, of projecten lezen en wijzigen via de REST API. Je maakt en beheert sleutels op de pagina Ontwikkelaar.
De pagina Ontwikkelaar openen#
Druk in het dashboardmenu onder Geavanceerd op Ontwikkelaar. Hij opent op API-sleutels, en de andere onderdelen staan eronder in het menu (op een telefoon als tabbladen bovenaan de pagina):
- Gastlink (Open Guest): de link zonder code voor je website. Zie Open Guest.
- De API uitproberen, Webhooks en REST API: zie de API-referentie.
- Een kaart insluiten (Enterprise): zie de iFrame API.
- Privéprojecten (Enterprise): toon privéprojecten van klanten in je embeds. Zie privéprojecten van klanten.
De badge bovenaan de sleutelkaart zegt of je sleutel Actief, Niet geactiveerd (nog geen sleutel), Uitgeschakeld (API-toegang opgeschort: geen enkele sleutel werkt en er kan geen nieuwe worden gemaakt tot support dit opheft) of Verlopen (het abonnement is niet actief) is.
Live en Sandbox#
Schakel bovenaan de sleutelkaart tussen Live en Sandbox. Elk heeft een eigen sleutel en de pagina toont degene die je kiest. De keuze geldt ook in De API uitproberen en blijft staan als je tussen onderdelen wisselt. Een kaart insluiten en Gastlink gebruiken altijd je livesleutel, omdat bezoekers van je website alleen liveprojecten kunnen openen: als je een van beide opent, gaat de pagina terug naar Live.
- Live is je echte account en de pagina opent hierop. Gebruik een livesleutel op je website.
- Sandbox is voor het bouwen en testen van een integratie. Projecten, mappen en producten die met een sandbox-sleutel zijn gemaakt, worden gescheiden van je echte gehouden: een livesleutel kan ze niet zien en een sandbox-sleutel kan je live projecten niet zien. Verzoeken met een sandbox-sleutel tellen niet mee in je gebruikscijfers en gastprojecten die ermee zijn gemaakt, worden nooit gefactureerd.
Een nieuwe sandbox-sleutel maken heeft nooit invloed op je livesleutel, en andersom.
Kies wat de sleutel kan doen#
Als je een sleutel maakt, toont het dialoogvenster onder Toegang voor de nieuwe sleutel elk onderdeel van de API. Kies hoe ver de nieuwe sleutel in elk ervan reikt:
| Onderdeel | Keuzes | Wat het toestaat |
|---|---|---|
| Ingesloten kaarten (Enterprise) | Geen toegang, Toegestaan | Log een kijker in bij een ingesloten kaart. De meeste integraties hebben alleen dit nodig. |
| Gastprojecten (Open Guest) | Geen toegang, Toegestaan | Start een gastproject voor een bezoeker, met een token van je server. De meeste integraties hebben alleen dit nodig. |
| Projecten | Geen toegang, Lezen, Lezen en wijzigen | Projecten en mappen, met hun metingen, opmerkingen en exports. |
| Gebruikers (Enterprise) | Geen toegang, Lezen, Lezen en wijzigen | De gebruikers van je organisatie, hun uitnodigingen, licenties en teams. |
| Organisatie (Enterprise) | Geen toegang, Lezen, Lezen en wijzigen | Het profiel, het beleid, de single sign-on en het activiteitenlogboek van je organisatie, en de licenties. |
| Producten | Geen toegang, Lezen, Lezen en wijzigen | Je productcatalogus en de prijzen ervan. |
| Gasten (Open Guest) | Geen toegang, Lezen, Lezen en wijzigen | Je gastlink, gastprojecten en offerteaanvragen, met de contactgegevens van je gasten, en je budget. |
| Account | Geen toegang, Lezen, Lezen en wijzigen | Je plan, licenties, API-gebruik, profiel en e-mailinstellingen, en bij Open Guest je uitgaven en budget. |
| Ontwikkelaar | Geen toegang, Lezen, Lezen en wijzigen | Je API-sleutels en webhook. Een sleutel reikt nooit verder dan zijn eigen toegang. |
| Klanten (Partner) | Geen toegang, Lezen, Lezen en wijzigen | Je klanten, de plannen die je voor ze betaalt, hun uitnodigingen en facturen. |
Het dialoogvenster toont alleen de onderdelen die je abonnement bevat. Houd de aanwijzer boven een keuze om precies te zien wat hij toestaat. Je eerste sleutel begint met alleen Ingesloten kaarten, genoeg voor een ingesloten kaart; een sleutel die een andere vervangt, begint met de toegang van die sleutel. Kies minstens één onderdeel.
Wat een sleutel mag doen, ligt vast als je hem maakt. Maak een nieuwe om een sleutel meer of minder toegang te geven.
Een sleutel maken#
- Kies bovenaan de sleutelkaart Live of Sandbox.
- Druk op Nieuwe sleutel genereren. Er opent een dialoogvenster, met Live of Sandbox naast de titel.
- Stel de toegang in onder Toegang voor de nieuwe sleutel (zie hierboven).
- Typ desgewenst een naam in Naam voor de nieuwe sleutel (optioneel), om je sleutels uit elkaar te houden.
- Druk op Maken.
Het dialoogvenster zegt dan Je nieuwe sleutel is klaar. Je kunt hem op elk moment opnieuw kopiëren vanaf deze pagina. Het toont de sleutel, verborgen op de eerste en laatste tekens na, en wat hij Kan doen. Druk op om hem volledig te tonen of op om de hele sleutel te kopiëren en druk dan op Gereed. De sleutelkaart toont hem op dezelfde manier onder Je API-sleutel. Je krijgt een e-mail elke keer dat er een sleutel op je account wordt gemaakt.
Sleutels van voor de toegangsinstellingen#
Een sleutel die is gemaakt voordat sleutels toegangsinstellingen hadden, kan alles behalve met producten werken. Zulke sleutels worden uitgefaseerd: de sleutelkaart zegt wanneer de jouwe ophoudt te werken en je krijgt ook een melding. Druk op Nieuwe sleutel genereren, dat de kaart dan als hoofdknop toont, en vervang de oude sleutel op je website of server vóór die datum. Het dialoogvenster begint met alleen Ingesloten kaarten, dus kies meer als je server dat nodig heeft.
Een sleutel vervangen#
Druk opnieuw op Nieuwe sleutel genereren als je een sleutel hebt en maak de nieuwe in het dialoogvenster. Het dialoogvenster zegt wat er met de huidige sleutel gebeurt: Er wordt een nieuwe sleutel gemaakt en je huidige sleutel blijft 24 uur werken, zodat je de sites die hem gebruiken kunt bijwerken. Je kunt hem eerder intrekken zodra je klaar bent. Een sleutel van voor de toegangsinstellingen blijft werken tot de datum die je is gegeven.
De oude sleutel gaat naar Vorige sleutels, met de tijd die hij nog heeft, wanneer hij voor het laatst is gebruikt en wat hij kan. Worden nog geaccepteerd terwijl je de nieuwe sleutel uitrolt. Trek er een in zodra niets hem meer gebruikt. Om hem meteen te stoppen, druk je op Intrekken en bevestig je; elke site die hem nog gebruikt, houdt direct op te werken. Je krijgt een e-mail als een sleutel wordt ingetrokken.
De websitebeperkingen worden naar de nieuwe sleutel gekopieerd. Je kunt ongeveer één keer per minuut een nieuwe sleutel maken.
De sleutel beperken tot je websites#
Alleen de websites op deze lijst kunnen je sleutel in een browser gebruiken: ingesloten kaarten en verzoeken van pagina's op andere sites worden geweigerd. Aanroepen vanaf een server worden niet beïnvloed.
- Typ onder Websitebeperkingen je site in
Voer een website of domein in: een domein zoals
example.com, een IP-adres oflocalhost. Je kunt een volledig adres plakken: alleen de naam van de site blijft over, zonderhttps://, het pad of de poort. - Druk op Toevoegen.
Een domein omvat ook zijn subdomeinen: example.com staat
shop.example.com toe. Druk op om een site te
verwijderen en bevestig; na de laatste werkt de sleutel vanaf elke website. Je
krijgt een e-mail wanneer een website van een sleutel wordt verwijderd.
De lijst geldt voor browsers. Een ingesloten kaart opent alleen op een pagina van een website uit de lijst; als de browser niet meldt op welke pagina hij zit, wordt hij geweigerd. Een REST API-verzoek vanaf een webpagina moet van een website uit de lijst komen. Een verzoek van je eigen server noemt geen website en wordt niet gecontroleerd. Measure Map Online zelf is altijd toegestaan, zodat de voorbeelden op deze pagina blijven werken.
Zien hoe de sleutel wordt gebruikt#
Gebruik telt al je livesleutels bij elkaar op, zodat de cijfers doorlopen als je een sleutel vervangt. Het toont de verzoeken van de laatste 30 dagen, van ingesloten kaarten en de REST API samen, met een balk per dag; het totaal Altijd; de Laatste toegang; wanneer de huidige sleutel is gemaakt (Sleutel gemaakt); en de Topdomeinen: de websites die je sleutels het meest gebruiken. Een website die je daar niet herkent, is een reden om de sleutel te beperken of te vervangen.
Sandbox-verzoeken worden niet geteld, dus de cijfers verschijnen alleen op Live. De verzoeken die deze pagina zelf doet, in De API uitproberen en de voorbeelden, tellen ook niet mee.
Houd je sleutel veilig#
- Geef elke sleutel alleen de toegang die hij nodig heeft. Een sleutel in een webpagina (bijvoorbeeld in het adres van een embed) moet alleen Ingesloten kaarten hebben.
- Deze sleutel kan je gegevens wijzigen. Bewaar hem op je server, nooit in een webpagina of app.
- Beperk een sleutel die in webpagina's wordt gebruikt tot je eigen websites.
- Laat de sleutel op de pagina verborgen als je je scherm deelt; kopiëren heeft hem nooit zichtbaar nodig.
- Als een sleutel mogelijk is uitgelekt, maak dan een nieuwe en trek de oude meteen in onder Vorige sleutels.
- Bouw en test met een Sandbox-sleutel, zodat experimenten nooit tussen je echte projecten belanden.
Hulp nodig?
Schrijf naar ons supportteam en vertel wat je probeerde te doen. Screenshots helpen.