API-Keys & Sicherheit

Einen API-Key erhalten

Um einen SmartMaps-Dienst zu nutzen, benötigen Sie einen API-Key. Registrieren Sie sich kostenlos und wählen Sie den Plan, der zu Ihren Anforderungen passt.

Ihren Key verwenden

Die meisten SmartMaps-Dienste authentifizieren mit Ihrem Key als Query-Parameter apiKey — oder als Option apiKey in den JavaScript-Bibliotheken. Zwei Dienste weichen davon ab:

Dienst	Authentifizierung
Maps, Static Maps, Geocoding, Routing, Area, Elevation, Weather, Timezone	Query-Parameter `apiKey` / Option `apiKey`
Autocomplete API	kurzlebiges Bearer-Token, das mit Ihrem Key angefordert wird (siehe Autocomplete → Token)
Address Search	HTTP-Basic-Authentifizierung

Key-Kodierung

API-Keys können in einer URL-kodierten Form ausgestellt werden (enthält %2F, %3D, …). Wenn Sie eine Anfrage-URL von Hand erstellen, führen Sie den Key nicht blind durch encodeURIComponent — ein bereits kodierter Key würde doppelt kodiert und als ungültig abgelehnt werden.

In den JavaScript-Bibliotheken wird dies für Sie übernommen.
Wenn Sie URLs von Hand erstellen und SmartMaps GL geladen ist, verwenden Sie smartmapsgl.encodeString(apiKey) — dies kodiert einen unkodierten Key, lässt einen bereits kodierten Key jedoch unverändert.

Ohne die Bibliothek verwenden Sie dieselbe idempotente Logik:

const key = apiKey === decodeURIComponent(apiKey) ? encodeURIComponent(apiKey) : apiKey;

Ihren Key schützen

Da Web-Karten im Browser laufen, ist Ihr Key im Seitenquelltext sichtbar. Schützen Sie ihn:

Beschränken Sie den Key auf Ihre Produktionsdomain(s) in Ihrem Konto unter account.smartmaps.app, damit er nicht auf anderen Websites verwendet werden kann.
Verwenden Sie separate Keys für Entwicklung und Produktion.
Committen Sie niemals einen uneingeschränkten Key in ein öffentliches Repository.

Demo-Keys in dieser Dokumentation

Die Keys, die in den Live-Beispielen auf dieser Seite gezeigt werden, sind Demo-Keys, die auf die Dokumentations-/Demo-Domain und ein niedriges Anfragelimit beschränkt sind. Sie funktionieren nicht auf Ihrer eigenen Domain — ersetzen Sie sie durch Ihren eigenen Key.

Siehe auch: Transaktionen & Kontingente · Attribution & Lizenzierung.