Einstellungen (POA)

API (POA)

Beschreibung von API-Keys zur Authentifizierung, ihren Vorteilen und der Anwendung im Teilnehmerportal.

API Keys

API Keys (Application Programming Interface Keys) oder auch API Schlüssel genannt sind eindeutige Identifikatoren, die zur Authentifizierung und Autorisierung bei der Nutzung von APIs verwendet werden. 
In der Teilnehmerverwaltung hat jeder Teilnehmer die Möglichkeit API Keys zur eigenen Nutzung anzulegen. Die Sektion API ist nach dem Login mit dem Verwaltungsnutzer des Teilnehmers (Admin) unter Einstellungen > API zu finden.

Was sind API Keys?

Ein API Key ist ein Code, der als eindeutiger Identifikator fungiert, um:

  • Den API-Aufrufenden zu identifizieren
  • Zugriff auf spezifische API-Funktionen zu gewähren
  • Nutzungslimits zu kontrollieren
  • API-Aufrufe zu protokollieren und zu überwachen

Vorteile von API Keys

  • Kontrolle: Ermöglichen präzise Steuerung der Zugriffe auf Ihre Daten
  • Überwachung: Jeder API-Zugriff kann einzeln überwacht werden
  • Sicherheit: Zugriffe können bei Bedarf schnell widerrufen werden
  • Isolation: Pro Zugriff/Anwendung sollte ein separater Schlüssel verwendet werden

Anwendung im Teilnehmerportal 

Im Teilnehmerportal können API-Schnittstellen genutzt werden, um Daten sicher mit anderen Anwendungen zu teilen. Der Zugriff wird dabei genau gesteuert und kann pro Freigabe überwacht werden.

Hinweis: Für jeden neuen Zugriff auf das Teilnehmerportal sollte ein separater API Key erstellt werden, um die Sicherheit zu erhöhen und eine bessere Kontrolle zu gewährleisten. API Keys können somit getrennt voneinander aktiviert oder deaktiviert werden.