Authentifizierung
Die Suede-Such-API authentifiziert sich mit einem Bearer-API-Schlüssel. Jede Anfrage muss Ihren Schlüssel
im Authorization-Header mit sich führen.
Einen Schlüssel erstellen
Erstellen und verwalten Sie Schlüssel in Ihrem Suede-Konto unter Einstellungen → Integration → API-Schlüssel:
- Geben Sie einen Namen für den Schlüssel ein, damit Sie ihn später wiedererkennen.
- Klicken Sie auf Erstellen. Der vollständige Schlüssel wird ein einziges Mal angezeigt: kopieren Sie ihn sofort und bewahren Sie ihn an einem sicheren Ort auf.
- Danach wird nur noch eine maskierte Form (
suede_live_abc123…wxyz) angezeigt. Suede speichert den rohen Schlüssel nie, er kann also nicht erneut abgerufen werden. Wenn Sie einen Schlüssel verlieren, widerrufen Sie ihn und erstellen Sie einen neuen.
Widerrufen Sie einen Schlüssel jederzeit über denselben Bildschirm; ein widerrufener Schlüssel funktioniert sofort nicht mehr.
Schlüsselformat
Ein Schlüssel sieht so aus:
suede_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxEr beginnt mit dem Präfix suede_live_, gefolgt von einem zufälligen Geheimnis. Behandeln Sie einen Schlüssel
wie ein Passwort: wer ihn besitzt, kann auf Kosten des Guthabens Ihres Kontos suchen. Halten Sie ihn
serverseitig; betten Sie ihn nie in clientseitigen Code, mobile Apps oder öffentliche Repositorys ein.
Der Authorization-Header
Senden Sie den Schlüssel bei jeder Anfrage als Bearer-Token:
Authorization: Bearer suede_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxEine authentifizierte Anfrage stellen
curl "https://api.suede.io/v1/search?q=hello+world" \ -H "Authorization: Bearer $SUEDE_API_KEY"
using var http = new HttpClient(); http.DefaultRequestHeaders.Authorization = new("Bearer", Environment.GetEnvironmentVariable("SUEDE_API_KEY")); var json = await http.GetStringAsync("https://api.suede.io/v1/search?q=hello+world"); Console.WriteLine(json);
const res = await fetch("https://api.suede.io/v1/search?q=hello+world", { headers: { Authorization: `Bearer ${process.env.SUEDE_API_KEY}` }, }); console.log(await res.json());
Geltungsbereiche
Ein in den Einstellungen Ihres Kontos erstellter Schlüssel führt den Geltungsbereich search, der Zugriff auf alle
v1-Such-Endpunkte und auf Nutzung gewährt. Eine Anfrage mit einem Schlüssel, dem der
erforderliche Geltungsbereich fehlt, wird mit HTTP 403 und type: insufficient_scope abgewiesen; siehe
Fehler.
Fehlgeschlagene Authentifizierung
Ein fehlender, fehlerhafter, ungültiger oder widerrufener Schlüssel gibt HTTP 401 zurück:
{ "error": { "type": "unauthorized", "message": "Provide a valid API key as a Bearer token.", "request_id": "…" } }
Nächste Schritte
- Verwenden Sie die Basis-URL (
api.suede.io). - Beginnen Sie mit der Web-Suche.
- Behandeln Sie Fehler und Ratenbegrenzungen.