Howto: Zugriff auf unsere APIs mit API Keys

Ein Teil unserer Daten wird über APIs (Application Programming Interface, Programmierschnittstellen) bereitgestellt: Liste unserer APIs.

Diese Seite beschreibt alle wichtigen Punkte für den Zugriff auf unsere APIs.

Tools für den Zugriff

Zugriffe sind ausschliesslich über HTTPS möglich. Sämtliche Tools, die HTTPS unterstützen, können somit verwendet werden (z. B. Postman, Bruno, curl, wget) oder Programmiersprachen und Libraries (Python requests, Java, JavaScript u. v. a.)

URLs der APIs

Die URLs für den Zugriff sind bei im Datenkatalog (Liste unserer APIs) und in den jeweiligen Cookbook-Seiten enthalten.

API-Keys

Für den Aufruf des APIs muss ein API-Key gelöst und im Request Header mitgegeben werden.

Lösen von neuen API-Keys im API-Manager

Ab dem 3. März 2025 können Keys über unseren neuen API Manager bezogen werden. (Menus und Benutzerführung des API-Managers nur in Englisch verfügbar).

Bild 1: Startseite des API-Managers.

Die wichtigsten Schritte:

1. Voraussetzung ist eine Registrierung mit E-Mail-Adresse, Name, Vorname und Passwort.
2. Anschliessend können eine oder mehrere “Applications” erstellt werden.
3. In der Übersichtsseite API Manager kann nun ein API ausgewählt werden (“read more”, dann “access with this plan”) und zu einer App hinzugefügt werden (“Select an App”)

Pro API kann nur ein Schlüssel bezogen werden.

Verwendung der Keys im Request Header

Bei Aufruf des APIs muss im HTTPS Request Header ein Feld “Authorization” mit dem Key mitgegeben werden:

"Authorization": "Bearer .... hier den Key einfügen ...."

Weitere, wichtige Punkte zu beachten

User-Agent im Header setzen

In der Regel muss auch ein Feld “User-Agent” im Header mitgegeben werden.

"User-Agent": "... beliebiger Wert ...."

Redirects zulassen

Manche unserer APIs verwenden redirects auf andere URLs. Daher sollten im jeweiligen Tool die entsprechenden Optionen gesetzt werden (z. B. allow_redirect=True oder ähnlich).

Kompression aktivieren

Wenn möglich, sollte der Client immer Daten-Kompression verwenden. Der Client sollte jene Formate, die er beherrscht, aufführen, beispielsweise für zip, Brotli und Deflate mit einem Eintrag:

"Accept-Encoding": "zip, br, deflate"

 

Beispiele

bruno

Bild 2: Hinzufügen der Header-Felder im API-Client-Tool bruno.

curl

Anwendungsbeispiele

folgen…