Envoyer votre première requête à l'API Stripe

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.

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.

1. Pour créer un client à l’aide du Shell Stripe, saisissez la commande suivante :

   Command Line

   stripe 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": 
   "cus_LfctGLAICpokzr",
     "object": 
   "customer",

   Afficher les 31 lignes

2. (Facultatif) Exécutez la même commande en passant votre clé secrète API dans un environnement de test :

   Command Line

   stripe customers create --email=jane.smith@email.com --name="Jane Smith" --description="My First Stripe Customer" --api-key sk_test_BQokikJOvBiI2HlWgH4olfQ2

   Si tout a fonctionné correctement, la ligne de commande affiche la réponse suivante :

   {
     "id": 
   "cus_LfdZgLFhah76qf",
     "object": 
   "customer",

   Afficher les 32 lignes

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.

Par défaut, tous les comptes disposent de quatre clés API au total, deux dans un environnement de test et deux en mode production :

• Clé secrète de l’environnement de test : utilisez cette clé pour authentifier les requêtes sur votre serveur lorsque vous effectuez des tests dans un environnement de test. Par défaut, vous pouvez utiliser cette clé pour effectuer toutes les requêtes API sans restriction. Réservez cette clé pour les activités de test et de développement de manière à ne pas risquer de modifier par accident des paiements ou des clients réels.
• Clé publiable de l’environnement de test : utilisez cette clé à des fins de test dans le code côté client de votre application Web ou mobile. Réservez cette clé pour les activités de test et de développement de manière à ne pas risquer de modifier par accident des paiements ou des clients réels.
• 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.

Vos clés secrète et publiable 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.

Lorsque vous êtes connecté(e), Stripe inclut automatiquement vos clés API de test dans les exemples de code de notre documentation. Personne d’autre que vous ne peut voir ces valeurs. Si vous n’êtes pas connecté(e), les exemples de code contiennent des clés API générées de manière aléatoire. 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.

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 :