> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getqr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Authentifizierung

> Erstellen Sie einen API-Schlüssel und authentifizieren Sie Ihre Anfragen.

> [!NOTE]
>
> Die GetQR API befindet sich in der Beta-Phase und steht ausgewählten Workspaces zur Verfügung. Details können sich bis zur allgemeinen Veröffentlichung noch ändern.

Die GetQR API authentifiziert jede Anfrage mit dem API-Schlüssel Ihres Kontos. Jede Person hat einen Schlüssel, und er handelt in einem Workspace in Ihrem Namen.

## Bevor Sie beginnen

* Sie sind Workspace-Admin oder Editor. Viewer können keinen API-Schlüssel erstellen oder verwenden.
* Der Workspace-Admin hat ein aktives Abonnement.

## API-Schlüssel erstellen

**1. Kontoeinstellungen öffnen**

Öffnen Sie Ihre Kontoeinstellungen und gehen Sie zu **API**.

**2. Schlüssel erzeugen**

Klicken Sie auf **Generate API key**.

**3. Schlüssel kopieren**

Zeigen Sie den Schlüssel an und kopieren Sie ihn. Schlüssel beginnen mit `sk_live_`.

Sie können den Schlüssel jederzeit erneut anzeigen und kopieren. Die Einstellungen zeigen außerdem, wann der Schlüssel erstellt und wann er zuletzt verwendet wurde.

## Anfragen authentifizieren

Senden Sie den Schlüssel bei jeder Anfrage als Bearer-Token im `Authorization`-Header:

```bash theme={null}
curl "https://getqr.com/api/v1/qrs" \
  -H "Authorization: Bearer sk_live_..."
```

| Problem | Antwort |
| - | - |
| Kein `Authorization`-Header | `401 unauthorized`: "Missing Authorization header." |
| Der Header beginnt nicht mit `Bearer ` | `400 bad_request`: "Misconfigured authorization header. Did you forget to add 'Bearer '?" |
| Unbekannter oder neu erzeugter Schlüssel | `401 unauthorized`: "Unauthorized: Invalid API key." |
| Ihre Rolle ist Viewer | `403 forbidden`: "API access is not available for this role." |
| Das Abonnement des Workspace-Admins ist nicht aktiv | `403 forbidden`: "Access denied: This account does not have an active subscription." |
| Die API ist für Ihren Workspace nicht freigeschaltet | `404 not_found`: "This endpoint is not available." |

Die [Statusprüfung](https://docs.getqr.com/de/api/endpoints/health.md) ist der einzige Endpunkt, der ohne Schlüssel funktioniert.

## Zugriff und Rollen

* **Rollen.** Nur der Workspace-Admin und Editoren können einen API-Schlüssel erstellen und verwenden. Viewer können das nicht.
* **Workspace.** Jeder Schlüssel gehört zu genau einem Workspace, und jede Anfrage läuft in diesem Workspace. Sie müssen keine Workspace-ID übergeben.
* **Laufende Prüfung.** Der Zugriff wird bei jeder Anfrage anhand Ihrer aktuellen Rolle und des Abonnements des Workspace-Admins geprüft. Ihr eigenes Abonnement spielt keine Rolle. Wird Ihre Rolle auf Viewer geändert oder endet das Abonnement des Admins, liefern Anfragen `403`, bis der Zugriff wiederhergestellt ist. Sie brauchen keinen neuen Schlüssel.
* **Entfernung.** Werden Sie aus dem Workspace entfernt, wird Ihr API-Schlüssel gelöscht. Werden Sie wieder hinzugefügt, erzeugen Sie einen neuen Schlüssel.

## Schlüssel neu erzeugen

Erzeugen Sie den Schlüssel neu, wenn er öffentlich geworden ist oder jemand ohne Berechtigung Zugriff darauf hat.

> [!WARNING]
>
> Ihr aktueller Schlüssel funktioniert sofort nicht mehr. Jede App oder Integration, die ihn verwendet, funktioniert erst wieder, wenn Sie den neuen Schlüssel eintragen.

**1. Auf Regenerate klicken**

Gehen Sie in Ihren Kontoeinstellungen zu **API** und klicken Sie auf **Regenerate**.

**2. Bestätigen**

Klicken Sie auf **Regenerate key**.

**3. Ihre Apps aktualisieren**

Kopieren Sie den neuen Schlüssel und ersetzen Sie den alten überall, wo Sie ihn verwenden.

## Schlüssel sicher aufbewahren

Behandeln Sie den Schlüssel wie ein Passwort: Wer ihn hat, kann QR-Codes in Ihrem Workspace erstellen, ändern und löschen.

* Speichern Sie ihn in einer Umgebungsvariable oder einem Secrets-Manager, nicht im Quellcode.
* Rufen Sie die API nur von Ihrem Server aus auf. Bauen Sie den Schlüssel nie in eine Website, eine mobile App oder etwas anderes ein, das Nutzer einsehen können.
* Geben Sie ihn nur an Entwickler weiter, die ihn brauchen.
* Erzeugen Sie ihn neu, sobald Sie vermuten, dass er öffentlich geworden ist.

## Häufige Probleme

> [accordion] Ich erhalte 401 mit einem Schlüssel, der bisher funktioniert hat
>
> Der Schlüssel wurde neu erzeugt, oder Sie wurden aus dem Workspace entfernt und der Schlüssel wurde gelöscht. Kopieren Sie den aktuellen Schlüssel aus Ihren Kontoeinstellungen oder erzeugen Sie einen neuen.

> [accordion] Ich erhalte bei jeder Anfrage 403
>
> Prüfen Sie, ob Ihre Rolle Admin oder Editor ist und ob das Abonnement des Workspace-Admins aktiv ist. Der Schlüssel funktioniert wieder, sobald der Zugriff wiederhergestellt ist.

> [accordion] Ich erhalte 404 "This endpoint is not available."
>
> Die API befindet sich in der Beta-Phase und ist für Ihren Workspace noch nicht freigeschaltet.

> [accordion] Ich sehe die API-Einstellungen nicht
>
> Sie erscheinen nur für den Workspace-Admin und Editoren und nur in Workspaces, in denen die API freigeschaltet ist.

## Wie geht es weiter?

> [card] [Einführung in die API](https://docs.getqr.com/de/api/introduction.md)

> [card] [Fehler](https://docs.getqr.com/de/api/errors.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.