Authentifizierung und API-Schlüssel
Erstellen Sie einen Schlüssel
Abschnitt betitelt „Erstellen Sie einen Schlüssel“Erstellen Sie einen sk_ API-Schlüssel im API-Center . Der vollständige Schlüssel wird nur einmal angezeigt, und zwar beim Erstellen oder Rotieren.
Verwenden Sie für jede Anwendung, Umgebung und automatisierte Aufgabe einen eigenen Schlüssel, damit jeder über ein eigenes Budget verfügen und unabhängig deaktiviert, rotiert und geprüft werden kann.
Senden Sie die Anmeldeinformationen
Abschnitt betitelt „Senden Sie die Anmeldeinformationen“Empfohlen:
X-API-Key: sk_your_keyDas Standardformular Bearer funktioniert ebenfalls:
Authorization: Bearer sk_your_keySenden Sie in einer Anfrage nur eines der beiden.
curl https://omnidoc.top/api/v1/jobs \ -H "X-API-Key: $OMNIDOC_API_KEY"Was ein Schlüssel darstellt
Abschnitt betitelt „Was ein Schlüssel darstellt“Ein Schlüssel gilt für das Konto, das ihn erstellt hat: Er kann nur die Dienste aufrufen und auf die Ressourcen dieses Kontos zugreifen, die dieses Konto nutzen darf. Ein Schlüssel kann die Anmelde-E-Mail-Adresse, das Passwort, die Telefonnummer oder das Profil nicht ändern und keine API-Schlüssel erstellen, rotieren oder widerrufen.
Optionale Grenzwerte:
allowed_engines: nur die aufgeführten Übersetzungseinstellungen; ein leeres Array fügt keine Schlüsselebene-Limitierung hinzu.expires_at: Ablaufzeit.quota_limit: Das Lebenszeitbudget des Schlüssels in ganzen Millikrediten;0legt kein Budget auf Schlüsselebene fest, und die Guthaben des Kontos werden wie üblich abgerechnet.
Drehen und widerrufen
Abschnitt betitelt „Drehen und widerrufen“Erstellen Sie Schlüssel, ändern Sie deren Grenzwerte, rotieren oder widerrufen Sie sie im API-Center . Sobald ein Schlüssel widerrufen, deaktiviert oder abgelaufen ist oder dessen Konto deaktiviert wurde, schlagen neue Anfragen sofort fehl.
Die Rotation erzeugt sofort einen neuen Secret und deaktiviert den alten; der neue Schlüssel behält die ursprünglichen Limits und das bereits verbrauchte Budget bei. Ein abgelaufener Schlüssel kann nicht rotiert werden; erstellen Sie stattdessen einen neuen. Für einen reibungslosen Wechsel erstellen Sie einen neuen Schlüssel, stellen ihn bereit und überprüfen, ob alle Aufrufe erfolgreich sind, bevor Sie den alten Schlüssel widerrufen.
Sicherheit
Abschnitt betitelt „Sicherheit“- Bewahren Sie Schlüssel ausschließlich auf dem Server oder in einer kontrollierten Laufzeitumgebung auf.
- Verwenden Sie Umgebungsvariablen oder einen Secret-Manager; geben Sie Schlüssel niemals in Quellcode, Protokolle, Browser-Bundles oder öffentliche Repositories ein.
- Senden Sie den Schlüssel niemals an die von der API zurückgegebenen Upload- oder Download-Adressen.
- Protokollieren Sie die Schlüssel-ID, die Anforderungs-ID und die Vorgangs-ID; protokollieren Sie niemals den vollständigen Schlüssel.
- Wenn ein Schlüssel kompromittiert wird, tauschen Sie ihn umgehend aus und überprüfen Sie seine Aufgaben und Belastungen.