Envoyer votre première requête à l'API Stripe
Premiers pas avec l'API Stripe.
Chaque appel à une API Stripe doit inclure une clé API secrète. Une fois votre compte Stripe créé, nous générons pour vous deux paires de clés API : une clé publique côté client et une clé secrète côté serveur pour le mode test et le mode production. Pour commencer à transférer des fonds réels avec vos clés du mode production, vous devez activer votre compte.
Avant de commencer
Ce guide vous explique comment effectuer une opération simple avec l’API Stripe : la création d’un client. Pour obtenir un aperçu plus complet des objets de l’API et de la manière dont ils fonctionnent entre eux, effectuez une visite guidée de l’API ou consultez la documentation de l’API. Si vous souhaitez commencer à accepter des paiements, consultez notre guide de démarrage rapide.
Envoyer votre première requête à l'API
Vous pouvez commencer à explorer les API de Stripe en utilisant le Shell Stripe. Le Stripe Shell vous permet d’exécuter des commandes de l’interface de ligne de commande Stripe directement sur le site de documentation Stripe. Puisqu’il fonctionne uniquement en mode test, vous n’avez pas à craindre de créer des transactions réelles.
Pour créer un client à l’aide du Shell Stripe, saisissez la commande suivante :
Command Linestripe customers create --email=jane.smith@email.com --name="Jane Smith" --description="My First Stripe Customer"
Si tout a fonctionné correctement, la ligne de commande affiche la réponse suivante :
{ "id":
, "object":"cus_LfctGLAICpokzr","customer"(Facultatif) Exécutez la même commande en transmettant votre clé API secrète pour le mode test :
Command Linestripe customers create --email=jane.smith@email.com --name="Jane Smith" --description="My First Stripe Customer" --api-key sk_test_4eC39HqLyjWDarjtT1zdp7dc
Si tout a fonctionné correctement, la ligne de commande affiche la réponse suivante :
{ "id":
, "object":"cus_LfdZgLFhah76qf","customer"
Afficher les logs et les événements
Lorsque vous appelez les API Stripe, Stripe crée et sauvegarde des objets API et Events pour votre compte utilisateur Stripe. La clé API spécifiée pour la requête détermine si les objets sont sauvegardés en mode test ou en mode production. Par exemple, la dernière requête ayant utilisé votre clé API secrète, Stripe a sauvegardé les objets en mode test.
Pour afficher le log de requête API :
- Ouvrez la page Logs.
- Cliquez sur 200 OK POST /v1 customers.
Pour afficher le log de l’événement :
- Ouvrez la page Événements.
- Cliquez sur jane.smith@email.com est un nouveau client.
Stockez vos clés API
Tous les comptes disposent par défaut de quatre clés API au total, deux pour le mode test et deux pour le mode production :
- Clé secrète du mode test : utilisez cette clé pour authentifier les requêtes sur votre serveur en mode test. Par défaut, vous pouvez l’utiliser pour effectuer n’importe quelle requête API sans restriction.
- Clé publiable du mode test : utilisez cette clé à des fins de test dans le code côté client de votre application Web ou mobile.
- 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.
Tests et développement
Utilisez uniquement vos clés API de test pour les tests et le développement. Vous éviterez ainsi toute modification accidentelle au niveau de vos clients ou de vos paiements réels.
Vous pouvez trouver vos clés secrètes et publiables dans les clés API. Lorsque vous êtes connecté, la documentation de Stripe alimente automatiquement les exemples de code avec vos clés API en mode test (vous seul pouvez voir ces valeurs). Si vous n’êtes pas connecté, nos exemples de code incluent des clés API générées aléatoirement. Vous pouvez les remplacer par vos propres clés de test ou vous connecter pour voir les exemples de code remplis avec vos clés API de test. Si vous ne pouvez pas voir vos clés API, demandez au propriétaire de votre compte Stripe de vous ajouter à leur équipe, avec les permissions appropriées.
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 :
Clés API limitées
Le Dashboard peut également générer des clés API restreintes, permettant un accès personnalisé et limité à l’API. Cependant, Stripe ne propose pas de clés restreintes par défaut.
Type | Valeur | Utilisation |
---|---|---|
Secrète | sk_ | Côté serveur : doit être gardée secrète et stockée en toute sécurité dans le code côté serveur de votre application Web ou mobile (par exemple, dans une variable d’environnement ou un système de gestion des identifiants) pour effectuer des appels aux API Stripe. Cette clé ne doit pas être affichée sur un site Web ou intégrée dans une application mobile. |
Publiable | pk_ | Côté client : peut être publiquement accessible dans le code côté client de votre application Web ou mobile (checkout.js, par exemple) pour collecter les informations de paiement de façon sécurisée, comme avec Stripe Elements. Par défaut, Stripe Checkout collecte les informations de paiement de façon sécurisée. |
Limitée | Une chaîne commençant par rk_ | Dans des microservices : doit être gardée secrète et stockée en toute sécurité dans votre code de microservice pour effectuer des appels aux API Stripe. Cette clé ne doit pas être affichée sur un site Web ou intégrée dans une application mobile. |