API-Schlüssel

Mit einem API-Schlüssel kann Ihre eigene Website oder Software mit Ihrem Konto bei Measure Map Online arbeiten: die Karte eines Projekts auf Ihrer Website anzeigen, Projekte für Ihre Besucher starten oder Projekte über die REST-API lesen und ändern. Schlüssel erstellen und verwalten Sie auf der Seite codeEntwickler.

Die Seite „Entwickler“ öffnen#

Klicken Sie im Menü des Dashboards unter Erweitert auf codeEntwickler. Die Seite öffnet sich mit vpn_keyAPI-Schlüssel, und ihre weiteren Abschnitte stehen darunter im Menü (auf dem Smartphone als Tabs oben auf der Seite):

• person_pin_circleGastlink (Open Guest): der Link ohne Programmierung für Ihre Website. Siehe Open Guest.
• terminalAPI ausprobieren, webhookWebhooks und apiREST-API: siehe die REST-API.
• web_assetKarte einbetten (Enterprise): siehe die iFrame-API.

Das Abzeichen oben auf der Schlüsselkarte zeigt, ob Ihr Schlüssel Aktiv, Nicht aktiviert (noch kein Schlüssel), Deaktiviert (API-Zugriff gesperrt: Kein Schlüssel funktioniert, und kein neuer kann erstellt werden, bis der Support die Sperre aufhebt) oder Abgelaufen (das Abonnement ist nicht aktiv) ist.

Live und Sandbox#

Wechseln Sie oben auf der Schlüsselkarte zwischen public Live und science Sandbox. Jede Umgebung hat ihren eigenen Schlüssel, und die Seite zeigt den der gewählten. Die Auswahl gilt auch in terminalAPI ausprobieren und bleibt erhalten, während Sie zwischen den Abschnitten wechseln. web_assetKarte einbetten und person_pin_circleGastlink verwenden immer Ihren Live-Schlüssel, weil Besucher Ihrer Website nur Live-Projekte öffnen können: Wenn Sie einen der beiden Abschnitte öffnen, wechselt die Seite zurück zu Live.

• Live ist Ihr echtes Konto, und die Seite öffnet sich damit. Verwenden Sie auf Ihrer Website einen Live-Schlüssel.
• Sandbox dient dazu, eine Integration zu entwickeln und zu testen. Projekte, Ordner und Produkte, die mit einem Sandbox-Schlüssel angelegt werden, bleiben von Ihren echten getrennt: Ein Live-Schlüssel sieht sie nicht, und ein Sandbox-Schlüssel sieht Ihre Live-Daten nicht. Anfragen mit einem Sandbox-Schlüssel werden in Ihren Nutzungszahlen nicht mitgezählt, und Gastprojekte, die mit einem solchen Schlüssel angelegt werden, werden nie abgerechnet.

Ein neuer Sandbox-Schlüssel wirkt sich nie auf Ihren Live-Schlüssel aus, und umgekehrt.

Festlegen, was der Schlüssel darf#

Unter Zugriff des neuen Schlüssels steht jede Zeile für einen Bereich der API. Wählen Sie, wie weit der nächste Schlüssel, den Sie erstellen, in diesen Bereich hineinreicht:

Halten Sie den Mauszeiger über eine Auswahl, um genau zu sehen, was sie gewährt. Ihr erster Schlüssel beginnt nur mit Eingebettete Karten, was alles ist, was eine eingebettete Karte braucht; ein Schlüssel, der einen anderen ersetzt, beginnt mit dem Zugriff dieses Schlüssels. Wählen Sie mindestens einen Bereich. Um sich über die API als eines der Mitglieder Ihrer Organisation anzumelden, brauchen Sie Benutzer: Lesen & ändern, nicht Eingebettete Karten.

Was ein Schlüssel darf, wird beim Erstellen festgelegt. Um einem Schlüssel mehr oder weniger Zugriff zu geben, erstellen Sie einen neuen.

Einen Schlüssel erstellen#

1. Wählen Sie Live oder Sandbox.
2. Legen Sie den Zugriff unter Zugriff des neuen Schlüssels fest.
3. Geben Sie bei Bedarf unter Name für den neuen Schlüssel (optional) einen Namen ein, um Ihre Schlüssel auseinanderzuhalten.
4. Klicken Sie auf refreshNeuen Schlüssel generieren.

Der Schlüssel erscheint unter Ihr API-Schlüssel, verborgen bis auf seine ersten und letzten Zeichen, mit einer Zeile, die seine Berechtigungen nennt. Klicken Sie auf visibility, um ihn vollständig anzuzeigen, oder auf content_copy, um den ganzen Schlüssel zu kopieren. Jedes Mal, wenn in Ihrem Konto ein Schlüssel erstellt wird, erhalten Sie eine E-Mail.

Ein Schlüssel, der erstellt wurde, bevor es Zugriffsbereiche gab, darf alles außer mit Produkten zu arbeiten und sich als Mitglied anzumelden; die Karte weist Sie darauf hin. Ersetzen Sie ihn durch einen eingeschränkteren, wenn Sie ihn nur für Einbettungen verwenden.

Einen Schlüssel ersetzen#

Klicken Sie erneut auf refreshNeuen Schlüssel generieren, wenn Sie bereits einen Schlüssel haben. Die App warnt Sie vorher: Es wird ein neuer Schlüssel erstellt und Ihr aktueller Schlüssel funktioniert noch 24 Stunden, damit Sie die Websites aktualisieren können, die ihn verwenden. Sie können ihn früher widerrufen, sobald Sie fertig sind.

Der alte Schlüssel wandert unter Frühere Schlüssel, mit der verbleibenden Zeit und dem Zeitpunkt seiner letzten Verwendung. Werden noch akzeptiert, während Sie den neuen Schlüssel ausrollen. Widerrufen Sie ihn, sobald ihn nichts mehr verwendet. Um ihn sofort zu stoppen, klicken Sie auf blockWiderrufen und bestätigen Sie; jede Website, die ihn noch verwendet, funktioniert dann sofort nicht mehr. Sie erhalten eine E-Mail, wenn ein Schlüssel widerrufen wird.

Ihre Website-Einschränkungen werden auf den neuen Schlüssel übertragen. Sie können etwa einmal pro Minute einen neuen Schlüssel erstellen.

Den Schlüssel auf Ihre Websites beschränken#

Nur die Websites auf dieser Liste können Ihren Schlüssel im Browser verwenden: Eingebettete Karten und Anfragen von Seiten anderer Websites werden abgelehnt. Aufrufe von einem Server sind davon nicht betroffen.

1. Geben Sie unter Website-Einschränkungen Ihre Website in Geben Sie eine Website oder Domain ein ein: eine Domain wie example.com, eine IP-Adresse oder localhost. Sie können eine vollständige Adresse einfügen: Gespeichert wird nur der Name der Website, ohne https://, Pfad und Port.
2. Klicken Sie auf addHinzufügen.

Eine Domain umfasst auch ihre Subdomains: example.com erlaubt shop.example.com. Klicken Sie auf delete_outline, um eine Website zu entfernen, und bestätigen Sie; nach der letzten funktioniert der Schlüssel von jeder Website aus. Sie erhalten eine E-Mail, wenn eine Website von einem Schlüssel entfernt wird.

Die Liste gilt für Browser. Eine eingebettete Karte öffnet sich nur auf einer Seite einer aufgeführten Website; wenn der Browser nicht angibt, auf welcher Seite sie sich befindet, wird sie abgelehnt. Eine REST-API-Anfrage, die von einer Webseite gesendet wird, muss von einer aufgeführten Website kommen. Eine Anfrage von Ihrem eigenen Server nennt keine Website und wird nicht geprüft. Measure Map Online selbst ist immer erlaubt, damit die Vorschauen auf dieser Seite weiter funktionieren.

Sehen, wie der Schlüssel verwendet wird#

Nutzung fasst alle Ihre Live-Schlüssel zusammen, sodass die Zahlen weiterlaufen, wenn Sie einen Schlüssel ersetzen. Es zeigt die Anfragen der letzten 30 Tage, von eingebetteten Karten wie von der REST-API, mit einem Balken pro Tag; die Summe Insgesamt; den Letzter Zugriff; wann der aktuelle Schlüssel erstellt wurde (Schlüssel erstellt); und die Häufigste Domains: die Websites, die Ihre Schlüssel am meisten verwenden. Eine Website, die Sie dort nicht kennen, ist ein Grund, den Schlüssel zu beschränken oder zu ersetzen.

Sandbox-Anfragen werden nicht gezählt, daher erscheinen die Zahlen nur unter Live. Ebenso wenig die Anfragen, die diese Seite selbst stellt, in terminalAPI ausprobieren und in den Vorschauen.

Ihren Schlüssel schützen#

• Geben Sie jedem Schlüssel nur den Zugriff, den er braucht. Ein Schlüssel in einer Webseite (zum Beispiel in der Adresse einer Einbettung) sollte nur Eingebettete Karten haben.
• Dieser Schlüssel kann Ihre Daten ändern. Bewahren Sie ihn auf Ihrem Server auf, nie in einer Webseite oder App.
• Beschränken Sie einen Schlüssel, der in Webseiten verwendet wird, auf Ihre eigenen Websites.
• Lassen Sie den Schlüssel auf der Seite verborgen, wenn Sie Ihren Bildschirm teilen; zum Kopieren muss er nicht angezeigt werden.
• Wenn ein Schlüssel möglicherweise bekannt geworden ist, erstellen Sie sofort einen neuen und widerrufen Sie den alten unter Frühere Schlüssel.
• Entwickeln und testen Sie mit einem Sandbox-Schlüssel, damit Experimente nie zwischen Ihren echten Projekten landen.