Elektronische Schnittstelle (API)

Die Interoperabilitätsplattform I14Y stellt zwei elektronische Schnittstellen zur Verfügung, so genannte Application Programming Interfaces (APIs):

  • Public API: Ermöglicht den Abruf von öffentlich publizierten Metadaten zu Datensätzen, elektronischen Schnittstellen, Behördenleistungen und Konzepten ohne Authentifizierung. Diese API richtet sich an alle Interessierten, die auf öffentliche I14Y-Metadaten zugreifen möchten.

  • Partner API: Ermöglicht autorisierten Personen, etwa Local Data Stewards, das Erfassen, Bearbeiten und Löschen von Metadaten mittels API-Zugriff. Um diese API zu nutzen, ist eine Authentifizierung erforderlich. Weitere Informationen zur Partner API finden Sie im Kapitel Datenerfassung über die elektronische Schnittstelle.

Diese Seite fokussiert auf die Public API zum Abruf von Metadaten.

Verfügbare Metadaten

Über die Public API sind folgende Informationen abrufbar:

  • Katalogdaten: Metadaten zu Datensätzen, elektronischen Schnittstellen (APIs) und Behördenleistungen
  • Konzepte: Definitionen zu Datenelementen inklusive Codelisten

Die API ermöglicht es unter anderem, Inhalte ab der Plattform direkt in eine Fachanwendung zu integrieren. So könnten etwa die Codelisten zur Berufsnomenklatur oder zu den Gemeindenummern an jene Webapp angebunden werden, über die in einer Befragung oder in einem Geschäftsprozess Daten erfasst werden. Die Interoperabilitätsplattform empfiehlt eine Zwischenspeicherung (Caching), falls I14Y an eine produktive Applikation angebunden wird.

import requests

concept_id = "08da7a0f-978f-8ca7-93a6-6f0f9a056cbc"
url = f"https://api.i14y.admin.ch/api/public/v1/concepts/{concept_id}?includeCodeListEntries=true"

response = requests.get(url)
data = response.json()
print(data)

Code-Beispiel: Abrufen einer Codeliste von I14Y mit der Skriptsprache Python.

Die Public API ist in der Swagger UI vollständig dokumentiert. Für die Nutzung ist keine Authentifizierung erforderlich. Nachfolgend werden einzelne besonders oft genutzte Endpunkte kurz beschrieben.

RessourceEndpunktBeschreibung
DatensatzGET /datasets/{id}Ruft die Metadaten eines bestimmten Datensatzes ab.
BehördenleistungGET /publicservices/{id}Ruft die Metadaten einer bestimmten Behördenleistung ab.
Elektronische SchnittstelleGET /dataservices/{id}Ruft die Metadaten einer bestimmten elektronischen Schnittstelle (API) ab.
KonzeptGET /concepts/{id}Ruft die Metadaten eines bestimmten Konzepts (z.B. Codeliste) ab.

Das Angebot an Endpunkten wird weiter ausgebaut. Die Interoperabilitätsstelle steht Ihnen bei Fragen und Wünschen zu den Endpunkten gerne zur Verfügung. Kontaktieren Sie uns unter i14y@bfs.admin.ch.