Clés API

Stripe authentifie vos requêtes API grâce aux clés API de votre compte. Si une requête ne contient pas de clé valide, Stripe renvoie une erreur de requête non valide. Si une requête contient une clé supprimée ou expirée, Stripe renvoie une erreur d’authentification.

Utilisez le Dashboard des développeurs pour créer, révéler, supprimer et renouveler les clés API. Pour accéder à vos clés API v1, sélectionnez l’onglet Clés API dans votre Dashboard.

Types de clés

By default, all accounts have a total of four API keys, two in a sandbox and two in live mode:

• Sandbox secret key: Use this key to authenticate requests on your server when you’re testing in a sandbox. By default, you can use this key to perform any API request without restriction. Reserve this key for testing and development to make sure that you don’t accidentally modify your live customers or charges.
• Sandbox publishable key: Use this key for testing purposes in your web or mobile app’s client-side code. Reserve this key for testing and development to make sure that you don’t accidentally modify your live customers or charges.
• Clé secrète du mode production : utilisez cette clé pour authentifier les requêtes sur votre serveur en mode production. Par défaut, vous pouvez l’utiliser pour effectuer n’importe quelle requête API sans restriction.
• Clé publiable du mode production : utilisez cette clé dans le code côté client de votre application Web ou mobile lorsque votre application est prête à être lancée.

Your secret and publishable keys are in the Dashboard in the API keys tab. If you can’t view your API keys, ask the owner of your Stripe account to add you to their team with the proper permissions.

When you’re logged in to Stripe, our documentation automatically populates code examples with your test API keys. Only you can see these values. If you’re not logged in, our code examples include randomly generated API keys. You can replace them with your own test keys or log in to see the code examples populated with your test API keys.

Le tableau suivant contient des exemples de clés API de test secrète et publique générées de manière aléatoire :

Environnement de test ou mode production

Toutes les requêtes à l’API Stripe s’effectuent en mode d’environnement de test ou en mode production. Utilisez un environnement de test pour accéder aux données de test, et le mode production pour accéder aux données réelles du compte. Chaque mode possède son propre jeu de clés API. Les objets accessibles dans un mode ne le sont pas dans l’autre. Par exemple, un objet Product d’environnement de test ne peut pas être utilisé dans le cadre d’un paiement en mode production.

Modifier une clé API

Le renouvellement d’une clé la révoque et génère une clé de remplacement. Vous pouvez renouveler une clé immédiatement ou programmer le renouvellement après un certain temps. Renouvelez une clé dans des scénarios tels que les exemples suivants :

• Vous perdez une clé secrète ou une clé limitée en mode production, et ne pouvez pas la récupérer à partir du Dashboard ; vous devez alors la remplacer.
• L’une de vos clés secrètes ou limitées est compromise, et vous devez la révoquer pour bloquer toute requête à l’API potentiellement malveillante.
• Votre politique exige de révoquer les clés à intervalles réguliers.

Pour renouveler une clé API :

1. Ouvrez la page Clés API.
2. Sur la ligne correspondant à la clé que vous souhaitez renouveler, cliquez sur le menu de dépassement (), puis sélectionnez Renouveler la clé.
3. Choisissez une date d’expiration dans le menu déroulant Expiration.
4. Cliquez sur Rotation de la clé API.
5. La boîte de dialogue affiche la nouvelle valeur de la clé. Copiez-la en cliquant dessus.
6. Enregistrez la valeur de la clé. Vous ne pourrez pas la récupérer plus tard.
7. Dans le champ Ajouter une note, saisissez l’emplacement où vous avez enregistré la clé et cliquez sur Terminé ou sur Enregistrer.

Si vous choisissez Maintenant pour le champ Expiration, nous supprimons l’ancienne clé. Si vous avez sélectionné une autre durée, le temps restant avant l’expiration de la clé s’affiche sous son nom.

Vous pouvez utiliser la nouvelle clé immédiatement, indépendamment de la date d’expiration de l’ancienne clé.

Lorsque vous renouvelez une clé publiable, le nom de la clé de remplacement est toujours Publishable key. Lorsque vous renouvelez une clé secrète, le nom de la clé de remplacement est toujours Secret key. Lorsque vous renouvelez une clé limitée, la clé de remplacement garde le nom de la clé initiale. Vous pouvez renommer une clé secrète ou limitée en cliquant sur son menu déroulant et en sélectionnant Modifier la clé.

Afficher les logs de requêtes API

Pour ouvrir les logs des requêtes API, cliquez sur le menu de débordement () de n’importe quelle clé, puis sélectionnez Afficher les logs des requêtes. L’ouverture des logs vous redirige vers le Dashboard Stripe principal.

Clés secrètes et limitées

Utilisez le Dashboard pour créer, supprimer, afficher et modifier des clés secrètes et limitées.

Créer une clé API secrète

Pour créer une clé API secrète :

1. Ouvrez la page Clés API.
2. Cliquez sur Créer une clé secrète.
3. Stripe envoie un code de vérification sur votre adresse e-mail ou par SMS (l’e-mail ou le SMS peut prendre un certain temps à arriver). Saisissez le code dans la boîte de dialogue. Au besoin, cliquez sur Continuer pour poursuivre.
4. Saisissez un nom dans le champ Nom de la clé.
5. Cliquez sur Créer.
6. La boîte de dialogue affiche la nouvelle valeur de la clé. Copiez-la en cliquant dessus.
7. Enregistrez la valeur de la clé. Vous ne pourrez pas la récupérer plus tard.
8. Dans le champ Ajouter une note, saisissez l’emplacement où vous avez enregistré la clé et cliquez sur Terminé.

Créer une clé API limitée

Une clé API limitée accorde uniquement le niveau d’accès que vous spécifiez.

Pour créer une clé API limitée :

1. Ouvrez la page Clés API.
2. Vous pouvez créer une clé limitée de toutes pièces ou dupliquer une clé limitée existante.
   • Pour créer une clé limitée de toutes pièces, cliquez sur Créer une clé limitée. Dans ce cas, la valeur par défaut pour toutes les autorisations est Aucune.
   • Pour cloner une clé existante, cliquez sur le menu déroulant () et sélectionnez Dupliquer la clé dans la ligne correspondant à la clé que vous souhaitez cloner. Dans ce cas, la valeur par défaut de chaque autorisation correspond à la valeur concernée de la clé clonée.
3. Dans le champ Nom de la clé, saisissez un nom. Si vous avez dupliqué une clé existante, le nom par défaut est celui de la clé dupliquée.
4. Pour chaque ressource à laquelle la nouvelle clé doit accéder, sélectionnez l’autorisation voulue. Si vous utilisez Connect, vous pouvez également sélectionner l’autorisation à accorder lors de l’accès aux comptes connectés avec cette clé. Les autorisations disponibles sont Aucune, Lecture ou Écriture.
5. Cliquez sur Créer une clé.
6. Stripe envoie un code de vérification sur votre adresse e-mail ou par SMS (l’e-mail ou le SMS peut prendre un certain temps à arriver). Saisissez le code dans la boîte de dialogue. Au besoin, cliquez sur Continuer pour poursuivre.
7. La boîte de dialogue affiche la nouvelle valeur de la clé. Copiez-la en cliquant dessus.
8. Enregistrez la valeur de la clé. Vous ne pourrez pas la récupérer plus tard.
9. Dans le champ Ajouter une note, saisissez l’emplacement où vous avez enregistré la clé et cliquez sur Terminé.

Supprimer une clé API secrète ou limitée

Si vous supprimez une clé, toutes les parties de votre code qui utilisent cette clé ne pourront plus effectuer d’appels à l’API. Après avoir supprimé une clé, créez-en une nouvelle et mettez à jour votre code pour l’utiliser.

Pour supprimer une clé :

1. Dans le Dashboard des développeurs, sélectionnez l’onglet Clés API.
2. Repérez la clé que vous souhaitez supprimer dans la liste Clés standard ou Clés limitées. Cliquez sur le menu déroulant () dans la ligne correspondant à cette clé, puis sélectionnez Supprimer la clé.
3. Si vous êtes sûr(e) de vouloir supprimer la clé, cliquez sur Supprimer la clé dans la fenêtre intitulée Supprimer la clé API. Sinon, cliquez sur Annuler.

Révéler une clé API secrète dans un environnement de test

Avec les environnements de test, vous pouvez révéler une clé API secrète autant de fois que vous le souhaitez.

Pour révéler une clé secrète dans un environnement de test :

1. Dans le Dashboard des développeurs, sélectionnez l’onglet Clés API.
2. Dans la liste **Clés Standard **, à la ligne Clé secrète, cliquez sur Révéler la clé de test.
3. Copiez la valeur de la clé en cliquant dessus.
4. Enregistrez la valeur de la clé.
5. Cliquez sur Masquer la clé de test.

Révéler une clé API secrète ou limitée pour le mode production

En mode production, Stripe n’affiche les clés API secrètes ou limitées qu’une seule fois (pour des raisons de sécurité). Enregistrez la clé dans un endroit où vous ne risquez pas de la perdre. Pour vous souvenir de l’endroit où vous l’avez stockée, vous pouvez ajouter une note à ce propos dans le Dashboard. Si vous perdez la clé, vous pouvez l’invalider ou la supprimer et en créer une autre.

Pour révéler une clé secrète ou limitée en mode production et ajouter une note :

1. Dans le Dashboard des développeurs, sélectionnez l’onglet Clés API.
2. Dans la liste Clés standard ou des Clés limitées, cliquez sur Révéler la clé de production au regard de la ligne correspondant à la clé que vous souhaitez révéler.
3. Copiez la valeur de la clé en cliquant dessus.
4. Enregistrez la valeur de la clé.
5. Cliquez sur Masquer la clé de test.
6. Cliquez sur le menu déroulant () à côté de la clé, puis sélectionnez Modifier la clé.
7. Dans le champ Note, saisissez l’emplacement où vous avez enregistré la clé, puis cliquez sur Enregistrer.
8. Si vous avez créé la clé avant que Stripe ne propose cette fonctionnalité, cliquez sur Masquer la clé de production.

Limiter les clés secrètes ou limitées à une liste ou une plage d’adresses IP

Pour limiter les requêtes API utilisant une clé à une ou plusieurs adresses IP spécifiques ou à une plage d’adresses IP :

1. Ouvrez la page Clés API.
2. Dans la liste Clés standard ou des Clés limitées, cliquez sur le menu déroulant () au regard de la ligne correspondant à la clé que vous souhaitez révéler, puis sélectionnez Gérer les restrictions des adresses IP.
3. Cliquez sur Limiter l’utilisation à un ensemble d’adresses IP.
4. Saisissez une adresse IP ou une plage d’adresses IP :
   • Pour une adresse IP individuelle, renseignez-la dans le champ Adresse IP.
   • Pour une plage d’adresses IP, entrez la plage en notation CIDR (Classless Inter-Domain Routing). Dans le champ Adresse IP, saisissez la première adresse de la plage. Dans le champ CIDR, entrez la taille du préfixe réseau.
   • Vous pouvez également sélectionner l’onglet Gestion en bloc et saisir des adresses IP individuelles et des plages, séparées par des espaces. Les modifications apportées dans un onglet apparaissent dans l’autre onglet.
5. Pour ajouter une autre adresse ou plage, cliquez sur + Ajouter.
6. Cliquez sur Enregistrer.

Modifier le nom ou la note d’une clé API secrète ou limitée

Pour modifier le nom ou le texte de la note d’une clé secrète ou limitée :

1. Ouvrez la page Clés API.
2. Dans la ligne correspondant à la clé à modifier, cliquez sur le menu déroulant (), puis sélectionnez Modifier la clé.
3. Si vous souhaitez modifier le nom de la clé, saisissez le nouveau nom dans le champ Nom de la clé.
4. Si vous souhaitez modifier le texte de la note, saisissez le nouveau texte dans Note.
5. Cliquez sur Enregistrer.

Protégez vos clés

N’importe qui peut utiliser votre clé API secrète en mode production pour effectuer un appel à l’API au nom de votre compte, par exemple pour créer un paiement ou procéder à un remboursement. Protégez vos clés en suivant les bonnes pratiques relatives aux clés API secrètes.