Passer au contenu principal
L’API Chariow utilise des clés API pour authentifier les requêtes.

Créer une clé API

1

Connexion au tableau de bord

Allez sur app.chariow.com et connectez-vous à votre compte.
2

Accéder aux paramètres

Cliquez sur Paramètres dans la barre latérale.
3

Ouvrir les clés API

Sélectionnez Clés API dans le menu des paramètres.
4

Créer une nouvelle clé

Cliquez sur Créer une clé API, donnez-lui un nom descriptif et copiez la clé générée.
Copiez votre clé API immédiatement après sa création. Pour des raisons de sécurité, la clé complète n’est affichée qu’une seule fois.

Effectuer des requêtes authentifiées

Incluez votre clé API dans l’en-tête Authorization de chaque requête :
Authorization: Bearer VOTRE_CLE_API

Exemple de requête

curl -X GET "https://api.chariow.com/v1/store" \
  -H "Authorization: Bearer VOTRE_CLE_API"

Bonnes pratiques de sécurité

Stockez les clés API dans des variables d’environnement, pas dans votre code :
# Fichier .env
CHARIOW_API_KEY=votre_cle_api

# Accès dans votre code
process.env.CHARIOW_API_KEY
Créez des clés API distinctes pour le développement, le staging et la production. Cela limite l’impact en cas de compromission d’une clé.
Créez périodiquement de nouvelles clés et désactivez les anciennes. Cela réduit la fenêtre d’opportunité pour les clés compromises.
Vérifiez régulièrement l’utilisation de vos clés API dans le tableau de bord. Recherchez les schémas inhabituels qui pourraient indiquer un accès non autorisé.
N’exposez jamais votre clé API dans le code côté client (JavaScript s’exécutant dans les navigateurs). Tous les appels API doivent être effectués depuis votre serveur.

Erreurs d’authentification

Si l’authentification échoue, vous recevrez une réponse 401 Non autorisé :
{
  "message": "La clé API est manquante. Veuillez fournir une clé API valide.",
  "data": [],
  "errors": []
}
Causes courantes des échecs d’authentification :
ErreurCauseSolution
En-tête manquantPas d’en-tête AuthorizationAjoutez l’en-tête à votre requête
Clé invalideLa clé n’existe pas ou a été suppriméeGénérez une nouvelle clé dans votre tableau de bord
Mauvaise boutiqueLa clé appartient à une autre boutiqueUtilisez la bonne clé pour votre boutique

Limitation de débit

Les clés API sont soumises à une limitation de débit pour garantir une utilisation équitable :
  • 10 requêtes par minute par clé API
En cas de dépassement, vous recevrez une réponse 429 Trop de requêtes.
Besoin de limites plus élevées ? Contactez notre équipe support à [email protected].

Prochaines étapes