Envoyer votre première requête à l'API Stripe
Premiers pas avec l'API Stripe.
Chaque appel à l’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. Vous pourrez les utiliser tant dans un environnement de test qu’en mode production. Pour commencer à transférer des fonds réels avec vos clés de 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 à l’aide de Stripe Shell. Stripe Shell vous permet d’exécuter des commandes de l’interface de ligne de commande Stripe directement depuis le site de documentation de Stripe. Celui-ci fonctionne uniquement dans un environnement de test, vous n’avez donc pas à vous soucier d’effectuer de véritables transactions de transfert de fonds.
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 passant votre clé secrète API dans un environnement de test :
Command Linestripe customers create --email=jane.smith@email.com --name="Jane Smith" --description="My First Stripe Customer" --api-key sk_test_BQokikJOvBiI2HlWgH4olfQ2Si 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 effectuez un appel aux API de Stripe, Stripe crée et stocke des objets API et Events pour votre compte d’utilisateur Stripe. La clé API que vous indiquez pour la requête détermine si les objets sont stockés dans un environnement de test ou en mode production. Par exemple, la dernière requête utilisait votre clé secrète API, donc Stripe a stocké les objets dans un environnement de 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
Par défaut, tous les comptes disposent au total de quatre clés API :
| Type | Description |
|---|---|
| Clé secrète en mode environnement de test | Authentifiez les requêtes sur votre serveur lors des tests en environnement de test. Par défaut, cette clé permet d’effectuer n’importe quelle requête API sans restriction. Réservez-la aux phases de test et de développement afin de vous assurer de ne pas modifier accidentellement vos clients ou vos paiements en mode production. |
| Environnement de test d’une clé publiable | Testez les requêtes dans le code côté client de votre application Web ou mobile. Réservez cette clé pour les tests et le développement afin de vous assurer de ne pas modifier accidentellement vos clients ou vos paiements en mode production. |
| Clé secrète en mode production | Authentifiez les requêtes sur votre serveur en mode production. Par défaut, vous pouvez utiliser cette clé pour effectuer n’importe quelle requête d’API sans restriction. |
| Clé publiable en mode production | Lorsque vous êtes prêt à lancer votre application, utilisez cette clé dans le code côté client de votre application Web ou mobile. |
Vos clés secrètes et publiables se trouvent dans l’onglet clés API du Dashboard. Si vous ne pouvez pas afficher vos clés API, demandez au propriétaire de votre compte Stripe de vous ajouter à son équipe avec les autorisations appropriées.
Clés API limitées
Vous pouvez générer des clés API restreintes dans le Dashboard pour permettre un accès personnalisé et limité à l’API. Cependant, Stripe ne propose pas de clés restreintes par défaut.
Si vous êtes connecté à Stripe, notre documentation remplit des exemples de code avec vos clés API 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 que vous pouvez remplacer par vos clés test. Vous pouvez également vous connecter pour voir les exemples de code remplis avec vos clés API test.
Exemples de clés API
Le tableau suivant présente des exemples de clés secrètes et publiques générées de manière aléatoire :
| 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. |