Zum Hauptinhalt springen

Übersicht

Steer AI nutzt API-Key-basierte Authentifizierung, um den Zugriff zu sichern. Alle API-Anfragen müssen einen gültigen API-Key in den Request-Headern enthalten.

API-Keys erhalten

1. Zugriff auf Ihr Dashboard

  1. Melden Sie sich im Steer AI Dashboard an
  2. Navigieren Sie zu SettingsAPI Keys
  3. Klicken Sie auf Generate New API Key

2. API-Key-Typen

Development-Keys

• Für Tests und Entwicklung • Begrenzte Rate Limits • Zugriff auf Sandbox-Umgebung • Kostenloser Plan verfügbar

Production-Keys

• Für Live-Anwendungen • Volle Rate Limits • Zugriff auf Produktionsumgebung • Erfordert bezahlten Plan

Authentifizierungsmethoden

Authentifizierung per HTTP-Header

Fügen Sie Ihren API-Key in den Authorization-Header ein:
curl -X GET "https://api.steerai.autos/v1/inspections" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Authentifizierung per Query-Parameter

Alternativ können Sie den API-Key als Query-Parameter übergeben:
curl -X GET "https://api.steerai.autos/v1/inspections?api_key=YOUR_API_KEY"
Sicherheitshinweis: Header-Authentifizierung wird empfohlen, damit API-Keys nicht in Server-Logs erscheinen.

Umgebungs-Konfiguration

Entwicklungsumgebung

# .env file
STEER_AI_API_KEY=dev_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
STEER_AI_BASE_URL=https://api-sandbox.steerai.autos/v1

Produktionsumgebung

# .env file
STEER_AI_API_KEY=prod_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
STEER_AI_BASE_URL=https://api.steerai.autos/v1

SDK-Authentifizierung

Python SDK

from steer_ai import SteerAI

# Initialize client
client = SteerAI(api_key="YOUR_API_KEY")

# Or using environment variable
import os
client = SteerAI(api_key=os.getenv("STEER_AI_API_KEY"))

JavaScript SDK

import { SteerAI } from '@steerai/sdk';

// Initialize client
const client = new SteerAI({
  apiKey: 'YOUR_API_KEY'
});

// Or using environment variable
const client = new SteerAI({
  apiKey: process.env.STEER_AI_API_KEY
});

Authentifizierung testen

Schnelltest

Verwenden Sie diesen Endpoint, um die Authentifizierung zu prüfen:
curl -X GET "https://api.steerai.autos/v1/auth/test" \
  -H "Authorization: Bearer YOUR_API_KEY"
Erwartete Antwort:
{
  "status": "success",
  "message": "Authentication successful",
  "account": {
    "id": "acc_1234567890",
    "name": "Your Company Name",
    "plan": "professional"
  }
}

Sicherheits-Best-Practices

• API-Keys in Umgebungsvariablen speichern, nie im Code • Getrennte Keys für Entwicklung und Produktion • Keys regelmäßig rotieren (empfohlen: alle 90 Tage) • Kompromittierte Keys sofort widerrufen
• HTTPS für API-Requests verwenden • SSL-Zertifikate korrekt validieren • IP-Whitelisting nutzen, wenn möglich • API-Nutzung auf ungewöhnliche Muster prüfen
• Berechtigungen auf das notwendige Minimum beschränken • Separate Keys für unterschiedliche Services • Fehlerbehandlung korrekt implementieren • Authentifizierungsfehler protokollieren

Rate Limiting

API-Keys haben je nach Plan unterschiedliche Limits:
PlanAnfragen/StundeGleichzeitige Anfragen
Free1,0005
Starter10,00020
Professional100,000100
EnterpriseUnbegrenztIndividuell

Fehlerbehandlung

Häufige Authentifizierungsfehler

{
  "error": {
    "code": "INVALID_API_KEY",
    "message": "The provided API key is invalid",
    "type": "authentication_error"
  }
}
{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Try again in 60 seconds",
    "type": "rate_limit_error",
    "retry_after": 60
  }
}

Umgang mit Authentifizierungsfehlern

try:
    response = client.inspections.create(data)
except SteerAIAuthenticationError as e:
    # Handle authentication error
    print(f"Authentication failed: {e.message}")
except SteerAIRateLimitError as e:
    # Handle rate limit
    print(f"Rate limit exceeded. Retry after {e.retry_after} seconds")

Fehlerbehebung

API-Key funktioniert nicht

  1. Key-Format prüfen: Sollte mit dev_ oder prod_ beginnen
  2. Umgebung prüfen: Stellen Sie die korrekte Base-URL sicher
  3. Planstatus prüfen: Konto muss aktiv sein
  4. Mit curl testen: Test-Endpoint oben verwenden

Zugriff verweigert

  1. Berechtigungen prüfen: Key benötigt die richtigen Scopes
  2. Planlimits prüfen: Nutzungsgrenzen nicht überschritten
  3. IP-Restriktionen prüfen: IP-Whitelisting konfigurieren
Brauchen Sie Hilfe bei der Authentifizierung? Kontaktieren Sie unser Support-Team unter [email protected] mit Ihrer Account-ID (geben Sie niemals Ihre API-Keys weiter).