Authentification
Authentification
Chaque requête 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 sont affichables : cliquez ultérieurement 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 d'affichage 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 verrou ; régénérez-les une fois pour effectuer la transition.
Utiliser votre clé API
Incluez votre clé API dans l'en-tête X-API-Key de chaque requête :
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é de la clé API
Traitez votre clé API comme un mot de passe :
- Ne la commitez 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.
- Effectuez une rotation 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 afin qu'un identifiant volé soit facile à repérer après coup.
Utilisation 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, espaces superflus ou clé désactivée | Vérifiez la clé, supprimez les espaces ou créez une nouvelle clé depuis le Dashboard |
Chaque response, qu'elle soit un succès ou un échec, comporte un header X-Foura-Request-Id, sauf si le body est illisible par FourA (JSON malformé ou body supérieur à 100 KB), auquel cas la requête est refusée avant l'attribution d'un ID. Enregistrez-le dans vos logs 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 de l'API : Référence complète des endpoints
- Gestion des erreurs : Gérez les erreurs d'authentification de manière fluide