Authentifizierung
Authentifizieren Sie API-Anfragen mit einem arbeitsbereichsbezogenen API-Schlüssel, der als Bearer-Token gesendet wird.
Jede Anfrage an die Nordvec-API authentifiziert sich mit einem API-Key, der als Bearer-Token im Authorization-Header gesendet wird.
curl https://nordvec.com/api/v1/documents/list \
-H "Authorization: Bearer $NORDVEC_API_KEY"Erstellen eines Schlüssels
Erstellen Sie einen Schlüssel in den Einstellungen Ihres Arbeitsbereichs. Der rohe Schlüssel wird genau einmal zurückgegeben und ist anschließend nicht mehr abrufbar. Kopieren Sie ihn daher sofort in Ihren geheimen Speicher. Schlüssel sind auf den Arbeitsbereich beschränkt, der sie erstellt hat.
Rotation und Entzug
Behandeln Sie einen API-Key wie ein Passwort. Wenn einer kompromittiert wird, rotieren oder entziehen Sie ihn umgehend.
- Rotation ersetzt die Anmeldedaten eines Schlüssels an Ort und Stelle. Die vorherigen Anmeldedaten funktionieren bis zum Ende eines kurzen Toleranzzeitraums weiter, sodass Sie einen Schlüssel ohne Ausfallzeit in Ihren Diensten einsetzen können.
- Entzug deaktiviert einen Schlüssel sofort; er kann sich nicht mehr authentifizieren.
Beide Aktionen erfordern eine angemeldete Sitzung (es handelt sich nicht um API-Key-Operationen selbst), sodass ein kompromittierter Schlüssel nicht zur Rotation oder zum Entzug seiner selbst verwendet werden kann.
Gute Praxis
- Speichern Sie Schlüssel in einem geheimen Manager oder einer Umgebungsvariable, niemals im Quellcode.
- Verwenden Sie für jeden Dienst oder jede Umgebung einen separaten Schlüssel, um gezielt entziehen zu können.
- Bevorzugen Sie kurzlebige Schlüssel für CI und Skripte.
War diese Seite hilfreich?
Erste Schritte
Erstellen Sie einen API-Schlüssel und führen Sie Ihre erste Dokumentensuche mit Nordvec durch.
Webhooks
Empfangen Sie signierte Ereignisbenachrichtigungen, wenn Dokumente indiziert werden, Lieferungen fehlschlagen oder Endpunkte ihren Zustand ändern. Überprüfung, Wiederholungsversuche und Tests.