Skip to content

API-Schlüssel

API-Anfragen mit sicheren API-Schlüsseln authentifizieren.

API-Schlüssel Dashboard

Übersicht

API-Schlüssel ermöglichen Ihnen:

  • API-Anfragen zu authentifizieren
  • Mit externen Systemen zu integrieren
  • Fotoanfrage-Workflows zu automatisieren
  • Eigene Anwendungen zu erstellen

Tarifanforderung

API-Zugang erfordert einen Tarif, der API-Funktionen enthält.

API-Schlüssel erstellen

Schritte

  1. Gehen Sie zu API-Schlüssel in der Seitenleiste
  2. Klicken Sie auf API-Schlüssel erstellen
  3. Geben Sie einen beschreibenden Namen ein
  4. Aktivieren Sie Aktiv (Standard: an)
  5. Klicken Sie auf Erstellen

Ihren Schlüssel speichern

Einmalige Anzeige

Der vollständige API-Schlüssel wird nur einmal bei der Erstellung angezeigt. Kopieren und speichern Sie ihn sicher. Sie können ihn später nicht abrufen.

Nach der Erstellung:

  • Kopieren Sie den Schlüssel sofort
  • Speichern Sie an einem sicheren Ort
  • Niemals öffentlich teilen

API-Schlüssel verwenden

Authentifizierungs-Header

Fügen Sie den API-Schlüssel in Anfrage-Header ein:

bash
curl -X GET "https://api.visio.now/v1/status" \
  -H "X-API-Key: ihr-api-schluessel-hier"

Header-Name

HeaderWert
X-API-KeyIhr API-Schlüssel

Beispielanfrage

bash
# Fotoanfrage erstellen
curl -X POST "https://api.visio.now/v1/photo-requests" \
  -H "X-API-Key: vsk_live_abc123..." \
  -H "Content-Type: application/json" \
  -d '{
    "instructions": "Bitte senden Sie Fotos des Fahrzeugs",
    "photo_slots": [
      {"instructions": "Vorderansicht", "is_required": true},
      {"instructions": "Rückansicht", "is_required": true}
    ]
  }'

API-Schlüssel verwalten

Schlüssel anzeigen

Die API-Schlüssel-Liste zeigt:

  • Schlüsselname
  • Maskierter Schlüssel (teilweise Anzeige)
  • Aktiv/Inaktiv-Status
  • Zuletzt verwendet Datum
  • Erstellungsdatum

Schlüssel bearbeiten

  1. Klicken Sie auf das Bearbeiten-Symbol
  2. Aktualisieren Sie den Namen
  3. Aktiv-Status umschalten
  4. Änderungen speichern

Schlüssel deaktivieren

Schlüssel vorübergehend deaktivieren:

  1. Klicken Sie auf Deaktivieren beim Schlüssel
  2. Bestätigen Sie die Aktion
  3. Schlüssel funktioniert sofort nicht mehr

Schlüssel aktivieren

Deaktivierten Schlüssel wieder aktivieren:

  1. Klicken Sie auf Aktivieren beim Schlüssel
  2. Bestätigen Sie die Aktion
  3. Schlüssel funktioniert sofort wieder

Schlüssel regenerieren

Neuen Schlüsselwert erstellen:

  1. Klicken Sie auf Regenerieren
  2. Bestätigen Sie die Aktion (alter Schlüssel funktioniert nicht mehr)
  3. Kopieren Sie den neuen Schlüssel sofort

Sofortige Ungültigkeit

Regenerieren macht den alten Schlüssel sofort ungültig. Aktualisieren Sie alle Integrationen vor dem Regenerieren.

Schlüssel löschen

Schlüssel dauerhaft entfernen:

  1. Klicken Sie auf Löschen
  2. Bestätigen Sie die Aktion
  3. Schlüssel wird dauerhaft entfernt

API-Schlüssel-Format

Schlüssel folgen diesem Format:

vsk_[umgebung]_[zufaellige-zeichenkette]
PräfixUmgebung
vsk_live_Produktion
vsk_test_Test

Sicherheits-Best-Practices

Schlüsselspeicherung

  • In Umgebungsvariablen speichern
  • Secrets-Management-Systeme verwenden
  • Niemals in Versionskontrolle committen
  • Nicht in clientseitigem Code einbinden

Schlüsselrotation

  • Schlüssel regelmäßig rotieren
  • Bei Kompromittierung sofort rotieren
  • Kurzlebige Schlüssel für Tests verwenden

Zugriffskontrolle

  • Separate Schlüssel pro Integration erstellen
  • Beschreibende Namen verwenden
  • Schlüsselnutzung überwachen
  • Ungenutzte Schlüssel deaktivieren

Was NICHT tun

  • Schlüssel in E-Mails teilen
  • Schlüssel in Chat/Slack posten
  • In URLs einbinden
  • In Klartext-Dateien speichern

Rate Limiting

API-Anfragen sind rate-limitiert:

LimitWert
Pro Minute60 Anfragen
Pro Stunde1.000 Anfragen

Rate-Limit-Header

Antworten enthalten:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1609459200

Limit überschritten

Bei Überschreitung:

  • HTTP 429-Antwort
  • Nach angegebener Zeit wiederholen
  • Exponentielles Backoff implementieren

Fehlerbehebung

401 Unauthorized

Ursachen:

  • Ungültiger API-Schlüssel
  • Schlüssel ist deaktiviert
  • Schlüssel wurde gelöscht/regeneriert
  • Fehlender Header

Lösungen:

  1. Verifizieren, dass Schlüssel korrekt ist
  2. Prüfen, dass Schlüssel aktiv ist
  3. Bei Bedarf regenerieren

403 Forbidden

Ursachen:

  • Schlüssel hat keine Berechtigung
  • Funktion nicht im Tarif
  • Arbeitsbereich-Einschränkungen

Lösungen:

  1. Tariffunktionen prüfen
  2. Schlüsselbesitz verifizieren
  3. Support kontaktieren

Schlüssel wird nicht angezeigt

Wenn Sie Ihren Schlüssel verloren haben:

  1. Der Original kann nicht abgerufen werden
  2. Regenerieren, um einen neuen zu erhalten
  3. Alle Integrationen aktualisieren

Schlüssellimits

Pro Tarif

TarifMax. API-Schlüssel
Professional5 Schlüssel
EnterpriseUnbegrenzt

Empfehlungen

  • Produktion: 1 Schlüssel pro Integration
  • Entwicklung: Separate Testschlüssel
  • CI/CD: Dedizierter Deployment-Schlüssel

Verwandte Seiten

Professionelle Plattform für Fotodokumentation