Übersicht/OpenAPI/Authentifizierung

Authentifizierung

Konfigurieren und überprüfen Sie Ihren API-Schlüssel sicher.

Bearer API Schlüssel

Jedes KPainter OpenAPI Endpoint mit Ausnahme von GET/Health verwendet den API-Schlüssel des Benutzers:

Authorization: Bearer <your_api_key>

Aktivieren und kopieren Sie einen Schlüssel aus dem API Key Seite.

Prüfen Sie die Verbindung zuerst

curl -s "https://api.kpainter.ai/openapi/v1/me" \  -H "Authorization: Bearer $KPAINTER_API_KEY"

Eine erfolgreiche Antwort gibt einen sicheren Konto und einen Plan-Summary zurück. Überprüfen Sie dies, bevor Sie Inhalte erstellen.

Die Schlüssel sicher

  • Halten Sie jeden Schlüssel in einem Server-Side-Secret Store oder vertrauenswürdigen Agentverbindung.
  • Nehmen Sie niemals einen Schlüssel in den Browsercode, ein Mobilpaket, einen Bildschirm oder Logs.
  • Verwenden Sie nicht einen gemeinsamen Schlüssel für unverwandte Endbenutzer.
  • Echo nie den vollen Schlüssel in einer Fehlermeldung.
  • Erfordern Sie den Benutzer, sich nach einer Schlüsselreinstellung erneut anzuschließen.

Gemeinsame Antworten

  • 401: Der Schlüssel fehlt, invalid oder inactive.
  • 403: Das Konto kann die gebuchte Kapazität nicht nutzen.
  • 422: Eine Feld- oder Parameterkombination ist nicht gültig.
  • 429: Anfragen sind zu häufig; folgen Sie der Antworten-Anleitung, bevor Sie sich zurückziehen.
  • Unzureichende Balance: Die Erstellung berichtet über ein Pause-Status, geschätzte Kredite und eine verfügbare Aktion. Erstellen Sie keine Duplikate.

API-Schlüsselaktivierung, Wiederinstellung und Löschung bleiben auf der KPainter-Website; die OpenAPI verwaltigt keine Schlüssel.