API-Schlüssel in Simbase erstellen und verwalten

Ein API-Schlüssel authentifiziert deine Anfragen an die Simbase API. Jeder Schlüssel bekommt beim Erstellen eine Reihe von Berechtigungen, und die stehen danach fest. Ein Schlüssel kann mehrere Integrationen bedienen, sicherer ist aber ein eigener Schlüssel pro Integration. Du erstellst und verwaltest Schlüssel im Dashboard unter Integrations → API.

API-Schlüssel erstellen

1. Melde dich an bei dashboard.simbase.com.

2. Öffne Integrations → API.

3. Klicke auf Create New API Key.

4. Gib dem Schlüssel einen Namen, der seinen Zweck beschreibt, zum Beispiel Usage Guard Toolkit. Der Name ist nur eine Bezeichnung. Er erscheint in deiner Schlüsselliste und sonst nirgends.

5. Lege unter Resources die Berechtigungen fest, die der Schlüssel braucht. Siehe Berechtigungen weiter unten.

6. Klicke auf Create API Key und kopiere den Schlüssel.

In der Demo unten siehst du alle Schritte:

Berechtigungen

Berechtigungen legst du pro Ressource fest, in einer von drei Stufen. None heißt, dass der Schlüssel keinen Zugriff auf diese Ressource hat. Das ist auf jeder Zeile der Standard. Read ruft Daten ab und ändert nichts. Write erstellt, ändert und löscht. Wählst du Write, wird Read in derselben Zeile mit ausgewählt, denn wer schreibt, muss vorher lesen.

Nicht jede Ressource bietet alle drei Stufen. Account und Usage sind schreibgeschützt und zeigen daher None und Read. SIM card state, Reset, Registration und Auto-disable sind Aktionen statt Daten und zeigen deshalb None und Write.

Der Ressourcenbaum

Über- und untergeordnete Zeilen

Neben SIM cards, Utilities und Integrations steht ein Pfeil. Klicke darauf, um die einzelnen Berechtigungen darunter aufzuklappen.

• Eine Stufe auf der übergeordneten Zeile gilt für jede untergeordnete Zeile, oder deren höchste verfügbare Stufe. Setzt du All resources auf Write, bekommen Account und Usage Read, denn mehr unterstützen sie nicht.

• Setzt du nur eine untergeordnete Zeile, zeigt die übergeordnete Zeile keine Auswahl. Das ist so gewollt. Eine übergeordnete Zeile zeigt nur dann eine Stufe, wenn alle untergeordneten Zeilen gleich stehen.

Die richtige Stufe wählen

Vergib nur so viel, wie die Integration braucht. Ein Schlüssel, der nur die Nutzung lesen kann, kann keine SIM deaktivieren, wenn er in falsche Hände gerät.

In der API-Referenz erscheinen diese als Scope-Namen, die auf demselben Baum basieren. SIM card details entspricht simcards.details:read und simcards.details:write.

Erweiterte Einstellungen

Aktiviere Show advanced settings für zwei optionale Felder. Beide kannst du leer lassen.

IP restrictions

Beschränkt den Schlüssel auf eine vertrauenswürdige IP-Adresse oder einen Bereich in CIDR-Notation. Anfragen von anderen Adressen werden abgelehnt. Lass das Feld leer, wenn du keine Beschränkung willst. Die Schlüsselliste zeigt dann 0.0.0.0/0 unter Allowed IPs, also jede Adresse.

Expires in (number of days)

Die Anzahl der Tage ab Erstellung, bis der Schlüssel nicht mehr funktioniert. Gib 31 ein, und der Schlüssel läuft in 31 Tagen ab. Lässt du das Feld leer, läuft der Schlüssel nie ab.

Kurzlebige Schlüssel lohnen sich für einmalige Migrationen, Zugänge für externe Dienstleister und alles, was du sonst selbst widerrufen müsstest.

Deine Schlüssel verwalten

Die API-Liste zeigt jeden Schlüssel im Konto: seinen Namen, eine gekürzte Key ID, die Berechtigungsstufe bei der Erstellung, die letzte Nutzung und die IP-Beschränkung. Last API call wird in der Zeitzone deines Kontos angezeigt, und Allowed IPs zeigt 0.0.0.0/0, wenn es keine Beschränkung gibt.

Die Key ID dient nur dazu, Schlüssel auseinanderzuhalten. Die ID ist gekürzt und taugt nicht zur Authentifizierung.

Berechtigungen stehen bei der Erstellung fest und lassen sich danach nicht ändern. Willst du ändern, was ein Schlüssel darf, erstellst du einen neuen mit den gewünschten Berechtigungen, stellst deine Integration um und löschst den alten.

Das Drei-Punkte-Menü am Ende jeder Zeile hat genau eine Option: Delete. Ein gelöschter Schlüssel funktioniert sofort nicht mehr, und Anfragen damit scheitern an der Authentifizierung.

Den Schlüssel verwenden

Sende den Schlüssel bei jeder Anfrage als Bearer Token mit:

Anfrage

GET /v2/simcards HTTP/1.1
Host: api.simbase.com
Authorization: Bearer YOUR_API_KEY

Die vollständige Endpunkt-Dokumentation findest du auf developer.simbase.com.

Häufige Fragen

Weiterführende Artikel

• Webhooks: Events an eine eigene URL senden lassen, ohne die API abzufragen

• Usage Guard Toolkit (DIY): eine fertige Automatisierung, die einen API-Schlüssel mit Write-Berechtigung nutzt

• Diebstahlschutz: der Scope simcards.details:write in der Praxis

• Zeitzone des Kontos: legt fest, in welcher Zeitzone die Spalte Last API call angezeigt wird