Zum Hauptinhalt springen

​
Überblick

Diese Seite behandelt Authentifizierung, Berechtigungen, Ablauf und sichere Speicherung von Developer-Platform-API-Schlüsseln. Jeder Schlüssel ist an ein Projekt gebunden und erlaubt nur die ausgewählten Aktionen.

​
API-Schlüssel der Developer Platform verwenden

Senden Sie bei jeder Anfrage diesen Authorization-Header.
Schlüssel aus den regulären NoimosAI-Teameinstellungen verwenden Workspaces, deren Berechtigungen und NoimosAI-Credits. Developer-Platform-Schlüssel nutzen eigene Projekte, Berechtigungen und USD-Prepaid-Guthaben.
Die Schlüsselarten sind nicht austauschbar. Ungültige Schlüssel, fehlende Berechtigungen oder unzureichendes Guthaben führen nie automatisch zu einer anderen Authentifizierung oder Abrechnung.

​
Benötigte Berechtigungen festlegen

Wählen Sie bei Erstellung nur die für Ihren Zweck erforderlichen Berechtigungen. Trennen Sie Schlüssel für Verbindungstests von Schlüsseln für kostenpflichtige Aufträge, um versehentliche Ausführungen zu begrenzen. Prüfen Sie für den üblichen Ablauf alle Berechtigungen für Projektabfrage, Angebot, Ausführung und Ergebnisabruf.

​
Wer Schlüssel erstellen darf

Projektmitglieder mit Rolle ADMIN oder DEVELOPER dürfen Schlüssel erstellen. Auch Organisationsadministratoren benötigen eine ausdrückliche Mitgliedschaft im Zielprojekt. Es gelten die Berechtigungen des Erstellers und Projekts. Wird das Erstellerkonto deaktiviert, der Ersteller aus dem Projekt entfernt oder der Schlüssel widerrufen, ist der Schlüssel nicht mehr nutzbar.

​
Ablauf verwalten

Wählen Sie die Gültigkeitsdauer in der Ansicht zur Schlüsselerstellung der Developer Platform und prüfen Sie sie nach der Erstellung in der Schlüsselliste. Der vollständige Schlüssel erscheint nur einmal; speichern Sie ihn sicher, bevor Sie die Ansicht schließen. Erstellen Sie vor Ablauf einen neuen Schlüssel, stellen Sie die Nutzung um und widerrufen Sie den alten. Bei Verdacht auf Offenlegung widerrufen Sie ihn sofort.

​
Schlüssel sicher speichern

Behandeln Sie API-Schlüssel als serverseitige Geheimnisse, die nicht an Browser der Nutzer verteilt werden.
  • In Umgebungsvariablen oder einem Secret-Manager speichern.
  • Nicht in Git, Logs, Fehleransichten oder Analyseereignisse schreiben.
  • Nicht in Browser- oder mobile Apps einbetten.
  • Getrennte Schlüssel und Projekte für Produktion, Staging und Entwicklung verwenden.
  • Schlüssel pro Einsatzzweck mit minimalen Berechtigungen erstellen.

​
Authentifizierungsfehler beheben

Prüfen Sie bei Fehlern HTTP-Status und Schlüsselzustand.
  • 401 — Authorization-Header, vollständigen Schlüssel, Ablauf und Widerruf prüfen.
  • 403 — Benötigte Berechtigungen und Projektzugriff des Schlüsselinhabers prüfen.
  • 429 — Anfragelimit, Prepaid-Guthaben und monatliche Organisations- oder Projektlimits prüfen.
Ist die Kombination aus Endpunkt und Schlüssel unklar, prüfen Sie vor kostenpflichtigen Aufträgen das Projekt mit GET /tools/project.

​
Weiterführende Seiten

Schlüsselerstellung und gemeinsame Spezifikationen erläutern diese Seiten.