Authentification

L'API de recherche de Suede s'authentifie avec une clé d'API bearer. Chaque requête doit porter votre clé dans l'en-tête Authorization.

Créer une clé

Créez et gérez des clés dans votre compte Suede dans Paramètres → Intégration → Clés d'API :

1. Saisissez un nom pour la clé, afin de pouvoir la reconnaître plus tard.
2. Cliquez sur Créer. La clé complète s'affiche une seule fois : copiez-la immédiatement et conservez-la en lieu sûr.
3. Par la suite, seule une forme masquée (suede_live_abc123…wxyz) est affichée. Suede ne stocke jamais la clé brute, elle ne peut donc pas être récupérée à nouveau. Si vous perdez une clé, révoquez-la et créez-en une nouvelle.

Révoquez une clé à tout moment depuis le même écran ; une clé révoquée cesse de fonctionner immédiatement.

Format de la clé

Une clé a cet aspect :

suede_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Elle commence par le préfixe suede_live_, suivi d'un secret aléatoire. Traitez une clé comme un mot de passe — quiconque la détient peut effectuer des recherches aux dépens du crédit de votre compte. Gardez-la côté serveur ; ne l'intégrez jamais dans du code côté client, des applications mobiles ou des dépôts publics.

L'en-tête Authorization

Envoyez la clé sous forme de jeton bearer à chaque requête :

Authorization: Bearer suede_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Faire une requête authentifiée

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());

Portées

Une clé créée dans les paramètres de votre compte porte la portée search, qui accorde l'accès à tous les endpoints de recherche v1 et à Utilisation. Une requête faite avec une clé qui n'a pas la portée requise est rejetée avec le code HTTP 403 et type: insufficient_scope — consultez Erreurs.

Échec d'authentification

Une clé absente, mal formée, invalide ou révoquée renvoie le code HTTP 401 :

{ "error": { "type": "unauthorized", "message": "Provide a valid API key as a Bearer token.", "request_id": "…" } }

Étapes suivantes

• Utilisez l'URL de base (api.suede.io).
• Commencez par Recherche web.
• Gérez les erreurs et les limites de débit.