Authentification
Chaque request envoyée à l'API FourA nécessite une authentification. Cette page explique comment obtenir, utiliser et gérer votre clé API.
Obtenir votre clé API
- Connectez-vous au tableau de bord FourA
- Accédez à la page API Keys
- Cliquez sur Create Key
- Copiez la clé depuis la boîte de dialogue de confirmation
Votre clé API ressemble à ceci : pk_live_a1b2c3d4e5f6...
Les clés créées aujourd'hui peuvent être révélées : cliquez plus tard sur l'icône en forme d'œil sur la ligne de la clé pour réafficher le secret complet à la demande (consultez Gérer les clés API pour le flux de révélation et les autorisations). Les anciennes clés créées avant le lancement de cette fonctionnalité ne peuvent pas être réaffichées et présentent une icône de cadenas ; régénérez-les une fois pour effectuer la transition.
Utiliser votre clé API
Incluez votre clé API dans le header X-API-Key de chaque request :
curl -X POST https://eu.api.foura.ai/api/single/ \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"method": "GET", "url": "https://example.com"}'
En Python :
import requests
response = requests.post(
"https://eu.api.foura.ai/api/single/",
headers={
"X-API-Key": "YOUR_API_KEY",
"Content-Type": "application/json"
},
json={"method": "GET", "url": "https://example.com"}
)
En Node.js :
const response = await fetch('https://eu.api.foura.ai/api/single/', {
method: 'POST',
headers: {
'X-API-Key': 'YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({ method: 'GET', url: 'https://example.com' })
});
Sécurité des clés API
Traitez votre clé API comme un mot de passe :
- Ne la validez pas dans le contrôle de version. Utilisez plutôt des variables d'environnement.
- Ne l'exposez pas dans le code côté client. Utilisez-la uniquement dans des applications côté serveur.
- Renouvelez-la en cas de compromission. Régénérez la clé depuis le Dashboard. L'ancien secret cesse de fonctionner en moins d'une minute, et chaque affichage est consigné dans les logs d'audit pour repérer facilement un identifiant dérobé après coup.
Utiliser des variables d'environnement
Stockez votre clé dans une variable d'environnement :
export FOURA_API_KEY="pk_live_a1b2c3d4e5f6..."
Référencez-le ensuite dans votre code :
import os
api_key = os.environ["FOURA_API_KEY"]
const apiKey = process.env.FOURA_API_KEY;
Erreurs d'authentification courantes
Tous les échecs d'authentification renvoient un statut 401 Unauthorized.
| Erreur | Message | Cause | Solution |
|---|---|---|---|
| 401 | Missing API key. Include X-API-Key header. | Aucun header X-API-Key dans la request |
Ajoutez le header X-API-Key |
| 401 | Invalid API key | Clé incorrecte, espace supplémentaire ou clé désactivée | Vérifiez la clé, supprimez les espaces superflus ou créez une nouvelle clé depuis le Dashboard |
Si FourA ne peut pas vérifier une clé temporairement, par exemple lors d'un basculement de sa base de données, il renvoie 503 avec API key check temporarily unavailable et Retry-After: 5, jamais 401. Réessayez après cette attente: votre clé est valide.
Chaque response, succès ou échec, comporte un header X-Foura-Request-Id, sauf si FourA ne peut pas lire le corps de la requête (JSON malformé ou corps supérieur à 100 Ko), auquel cas elle est refusée avant l'attribution d'un ID. Enregistrez-le de votre côté afin que le support puisse retrouver un appel spécifique ultérieurement.
Étapes suivantes
- Démarrage rapide : Effectuez votre première request
- Gestion des clés API : Afficher, modifier, régénérer et supprimer des clés
- Endpoints d'API : Référence complète des endpoints
- Gestion des erreurs : Gérer les erreurs d'authentification de manière fluide