API-Key

Ein API-Key (oder API-Schlüssel) ist ein geheimer Code, der Anwendungen oder Nutzer eindeutig identifiziert. Diese Seite bietet Informationen zur Notwendigkeit, Beantragung und sicheren Verwendung von API-Keys. Sie richtet sich an Entwickler und Systemintegratoren, die PVOG REST‑APIs nutzen, und erläutert die Beantragung, Einbindung in HTTP-Requests sowie den sicheren Umgang mit dem Key.

info

Vorerst ist die Verwendung von API-Keys optional und allein für den Suchdienst vorgesehen.

Bei Fragen oder Problemen wenden Sie sich gerne an den PVOG Support (dataportpvogsupport@dataport.de).

Was ist der API‑Key?

• Ein eindeutiger Client‑Identifier (UUID), der Ihre Anwendung gegenüber den PVOG REST‑APIs identifiziert.
• Format: UUID v4, z.B. d526c5db-75fc-4ee4-a727-218ed279701c.

Warum wird ein API‑Key benötigt?

• Identifikation Ihres Clients bei API‑Zugriffen.
• Schnellere, zielgerichtetere Unterstützung durch den PVOG Support bei Problemen oder API‑Änderungen.
• Bessere Möglichkeit zur Benachrichtigung und Betreuung der API‑Konsumenten bei wichtigen Änderungen.
• Grundlage für zukünftige Verbesserungen und Anpassungen der Dienste.

Wie erhalte ich einen API‑Key?

• Beantragung über unten stehendes Formular.
• Sie erhalten anschließend den Key sicher übermittelt.

Wie ist der API–Key zu verwenden?

• Senden Sie den API‑Key in jedem API‑Request an den Suchdienst im HTTP‑Header pvog-sud-api-client-id mit.
• Beispielaufruf:

  curl -H "Accept: application/json" \
       -H "pvog-sud-api-client-id: d526c5db-75fc-4ee4-a727-218ed279701c" \
       "https://pvog.fitko.net/suchdienst/api/v1/servicedescriptions/suggestions/020000000000?q=Hundesteuer"

• Derzeit unterstützt der Suchdienst die Verwendung des API‑Keys. Eine Unterstützung in weiteren PVOG REST‑APIs ist für die Zukunft geplant.

Achtung

Achten Sie darauf, den API‑Key vertraulich zu behandeln und nicht öffentlich zugänglich zu machen!

Formular