API-Beschränkung auf IP-Adressen

Wozu die IP-Beschränkung dient

Solange die Liste der erlaubten Adressen leer ist, nimmt die API Anfragen von überall an — das Portal zeigt dies mit dem Text The API is accessible from any IP address an. Sobald Sie die erste Adresse zur Liste hinzufügen, bedient die API nur noch Anfragen, die von den aufgeführten Adressen kommen.

Keines Ihrer Zugangsdaten verliert dadurch seine Gültigkeit. Sowohl die Application ID als auch das API-Token bleiben gültig, sie lassen sich nur nicht von einer anderen als einer erlaubten Adresse verwenden.

Wo Sie die Beschränkung einstellen

Klicken Sie im Menü des Portals auf Module und APIs
Klicken Sie unter Meine APIs und Module auf die Karte Ihrer Anwendung
Bleiben Sie auf der Registerkarte Die Einstellungen und scrollen Sie zum Bereich API access restrictions
Klicken Sie auf der Karte Allowed IP addresses auf Konfigurieren
Geben Sie die Adresse in das Feld Enter the IP address ein und klicken Sie auf Hinzufügen

Der Bereich API access restrictions mit der Karte Allowed IP addresses

Das Fenster Add IP address weist gleich mit der Meldung The API will only be accessible from the listed IP addresses! darauf hin — die Beschränkung greift, sobald die erste Adresse gespeichert ist.

Warnung

Geben Sie die Adresse ein, von der Ihre Anwendung die API aufruft, nicht die Adresse des Computers, an dem Sie dies einrichten. Nach dem Speichern prüft das Portal nicht, ob sich tatsächlich jemand von der eingegebenen Adresse verbindet.

Welche Adressen das Portal akzeptiert

Regel	Verhalten
Eine konkrete Adresse	IPv4 und IPv6 gleichermaßen; Bereiche und die Schreibweise mit Maske (`/24`) werden nicht akzeptiert
Nur öffentliche Adressen	Lokale und reservierte Bereiche enden mit der Meldung `Enter a public IP address, local and reserved ranges cannot be used`
Gültige Schreibweise	Ein unsinniger Wert endet mit der Meldung `Invalid IP address`
Keine Duplikate	Eine Adresse, die bereits in der Liste steht, kann nicht ein zweites Mal hinzugefügt werden

Zu den nicht öffentlichen Bereichen gehören 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, 127.0.0.0/8 und bei IPv6 fc00::/7 oder fe80::/10. Die Schaltfläche Hinzufügen bleibt deaktiviert, bis der eingegebene Wert die Prüfung besteht.

Eine als in IPv6 eingebettete IPv4 geschriebene Adresse — also ::ffff:1.2.3.4 oder die 6to4-Form 2002:… — wandelt das Portal in die entsprechende IPv4 um. Die Anzahl der Adressen in der Liste ist nicht begrenzt.

So bearbeiten Sie die Liste oder heben die Beschränkung auf

Nach dem Hinzufügen der ersten Adresse wird aus der Karte eine Liste. Die Schaltfläche Hinzufügen fügt eine weitere Adresse hinzu, das Papierkorbsymbol in einer Zeile entfernt eine — das Entfernen bestätigen Sie mit der Schaltfläche Löschen. Der Pfeil neben Hinzufügen öffnet ein Menü, mit dem Sie die ganze Liste auf einmal leeren.

Sobald keine Adresse mehr in der Liste steht, ist die Beschränkung ausgeschaltet und die API ist wieder von überall erreichbar.

Was mit einer Anfrage von einer anderen Adresse passiert

Eine Anfrage von einer Adresse, die nicht in der Liste steht, endet mit einer Antwort mit dem HTTP-Code 401 und dem Fehlertyp unknown_identity — demselben, den ein ungültiges Token zurückgibt. Die übrigen Fehler sind auf der Seite API-Fehlertypen aufgeführt.

War diese Seite hilfreich?

KI fragen Kopiert