Client ID

Eine Client ID ist ein geheimer Code, der Anwendungen oder Nutzer eindeutig identifiziert. Diese Seite bietet Informationen zur Notwendigkeit, Beantragung und sicheren Verwendung von Client IDs. 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 den Client IDs.

info

Die Verwendung von Client IDs ist 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 eine Client ID?

• 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 eine Client ID 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 eine Client ID?

• Beantragung über unten stehendes Formular.
• Sie erhalten anschließend die Client ID sicher übermittelt.

Wie ist die Client ID zu verwenden?

• Senden Sie die Client ID 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 der Client IDs. Eine Unterstützung in weiteren PVOG REST‑APIs ist für die Zukunft geplant.

Achtung

Achten Sie darauf, die Client ID vertraulich zu behandeln und nicht öffentlich zugänglich zu machen!

Formular