API-Dokumentation

Authentifizierung

API-Authentifizierung

Alle API-Anfragen erfordern eine Authentifizierung mit einem API-Schlüssel. Dieser Leitfaden erklärt, wie Sie API-Schlüssel sicher erstellen, verwalten und verwenden.

Einen API-Schlüssel erhalten

Um einen API-Schlüssel zu erhalten, müssen Sie ein iloveQR-Konto haben und Teil einer Organisation sein.

Melden Sie sich bei Ihrem Konto an

Einloggen oder ein Konto erstellen, wenn Sie noch keines haben.

Navigieren Sie zur Entwicklerseite

Gehen Sie zu Dashboard → Entwickler, um Ihre API-Schlüssel zu verwalten.

Einen neuen API-Schlüssel erstellen

Klicken Sie auf 'API-Schlüssel erstellen', geben Sie ihm einen beschreibenden Namen und speichern Sie den generierten Schlüssel sicher.

Ihren API-Schlüssel verwenden

Fügen Sie Ihren API-Schlüssel in den X-API-Key-Header bei jeder Anfrage ein:

Anfrage-Header

curl -X GET \
  https://api.iloveqr.com/api/v1/organizations/YOUR_ORG_ID/qr-codes \
  -H "X-API-Key: ilqr_your_api_key_here" \
  -H "Content-Type: application/json"

Organisations-ID

Die meisten API-Endpunkte erfordern eine Organisations-ID im URL-Pfad. Sie finden Ihre Organisations-ID in den Dashboard-Einstellungen oder indem Sie eine Anfrage an den Organisationsendpunkt stellen.

Holen Sie sich Ihre Organisationen

curl -X GET \
  https://api.iloveqr.com/api/v1/users/me/organizations \
  -H "X-API-Key: ilqr_your_api_key_here"

Antwort

{
  "organizations": [
    {
      "id": "org_abc123",
      "name": "My Company",
      "slug": "my-company",
      "role": "ADMIN"
    }
  ]
}

Sicherheitsbest Practices

Setzen Sie API-Schlüssel niemals in clientseitigem Code aus

Machen Sie API-Aufrufe immer von Ihrem Server. Fügen Sie niemals API-Schlüssel in JavaScript ein, das im Browser, in mobilen Apps oder in irgendeinem Code ausgeführt wird, der von Benutzern eingesehen werden kann.

Verwenden Sie Umgebungsvariablen

Speichern Sie Ihre API-Schlüssel in Umgebungsvariablen, nicht in Ihrem Code. Dies verhindert eine versehentliche Offenlegung durch Versionskontrolle.

Drehen Sie die Schlüssel regelmäßig

Erstellen Sie regelmäßig neue API-Schlüssel und widerrufen Sie alte. Wenn Sie vermuten, dass ein Schlüssel kompromittiert wurde, widerrufen Sie ihn sofort.

Authentifizierungsfehler

Wenn die Authentifizierung fehlschlägt, gibt die API eine dieser Fehlermeldungen zurück:

Statuscode	Fehler	Beschreibung
401	UNAUTHORIZED	Fehlender oder ungültiger API-Schlüssel
403	FORBIDDEN	API-Schlüssel hat keine Berechtigung für diese Aktion
403	API_KEY_REVOKED	Der API-Schlüssel wurde widerrufen

Beispiel für eine Fehlermeldung

{
  "statusCode": 401,
  "message": "Invalid or missing API key",
  "error": "Unauthorized"
}

Nächste Schritte

Jetzt, da Sie die Authentifizierung verstehen, lernen Sie, wie Sie die API verwenden: