Accéder directement au contenu
Créez un compte
ou
connecter-vous
Logo de la documentation Stripe
/
Demander à l'assistant IA
Créez un compte
Connectez-vous
Démarrer
Paiements
Revenus
Plateformes et places de marché
Gestion de fonds
Outils de développement
Aperçu
Gestion des versions
Journal des modifications
Mettre à niveau votre version de l'API
Actualiser votre version du SDK
Outils de développement
SDK
API
Tests
Workbench
Destinations d'événements
Workflows
CLI Stripe
Shell Stripe
Dashboard des développeurs
Boîte à outils des agents
Intégrer des LLMStripe pour Visual Studio CodeAlertes d'intégrité de StripeChargements de fichiers
Sécurité et confidentialité
Sécurité
Confidentialité
Extensions Stripe
Stripe Apps
    Présentation
    Démarrer
    Créer une application
    Fonctionnement de Stripe Apps
    Exemples d'application
    Créer une application
    Enregistrer des clés secrètes
    Méthodes d'authentification de l'API
    Flux d'autorisation
    Logique côté serveur
    Écouter les événements
    Gérer différents modes
    Activer la prise en charge de l'environnement de test
    Page des paramètres d'application
    Concevoir une interface utilisateur
    Inscription des utilisateurs
    Distribuer votre application
    Options de distribution
    Charger votre application
    Versions
    Tester votre application
    Publier votre application
    Faire la promotion de votre application
    Ajouter des liens profonds
    Créer des liens d'installation
    Assigner des rôles dans les extensions d'interface utilisateur
    Actions post-installation
    Analyses de l'application
    Composants intégrés pour les applications
    Intégrer des applications tierces conçues pour Stripe
    Migrer vers Stripe Apps
    Migrer ou développer une extension
    Migrer un plugin vers Stripe Apps ou Stripe Connect
    Référence
    Manifeste de l'application
    Interface de ligne de commande
    SDK d'extension
    Autorisations
    Fenêtres d'affichage
    Modèles de conception
    Composants
Connecteurs Stripe
Partenaires
Partner ecosystem
Certification des partenaires
AccueilOutils de développementStripe Apps

Ajouter une page des paramètres pour votre application

Créez une page où les utilisateurs pourront configurer leurs paramètres pour votre application Stripe.

Copier la page

Lorsque vous chargez votre application dans Stripe, nous lui créons une page de paramètres dédiée dans le Dashboard Stripe. Vous pouvez agencer librement le reste de la page et créer une vue des paramètres personnalisée.

Comment utiliser les paramètres de l’application

Un administrateur de compte qui installe votre application peut utiliser la page des paramètres pour :

  • Configurer votre application pour son cas d’usage : par exemple, imaginons qu’une entreprise utilisant Stripe souhaite synchroniser les données de paiement des sept derniers jours avec une autre application. Votre page de paramètres peut proposer un menu déroulant permettant aux administrateurs de sélectionner une période d’une semaine. La configuration s’applique de manière globale sur le compte, ce qui signifie que tous les utilisateurs de ce compte Stripe peuvent désormais voir les données de la semaine passée dans votre application.
  • Authentifier des utilisateurs : si votre application se connecte à une application externe à Stripe, vous devez permettre aux utilisateurs de Stripe de se connecter à l’autre application, transmettre leurs identifiants et gérer l’authentification. Pour cela, nous vous conseillons fortement d’utiliser la page des paramètres. Par exemple, une application qui utilise une API tierce comme Zendesk nécessite une SettingsView pour authentifier un utilisateur avec son compte Zendesk.
  • Désinstaller une application : la page des paramètres est le seul emplacement qui permet de désinstaller une application. Vous ne pouvez pas supprimer le bouton Désinstaller de la page des paramètres. Les utilisateurs peuvent également cliquer sur des boutons pour signaler votre application et afficher son référencement sur les places de marché, le cas échéant.

Fonctionnalités

Par défaut, la page de paramètres comporte des boutons permettant de désinstaller et signaler votre application, en plus de fournir des information diverses sur celle-ci. Utilisez un composant SettingsView pour remplir la page avec des paramètres personnalisés. Il s’agit d’un composant racine de la vue qui s’affiche dans la page des paramètres. Ajoutez des composants d’interface utilisateur, comme des onglets et des champs de formulaire, pour créer votre propre expérience utilisateur.

SettingsView dans le Dashboard Stripe

Exemple de SettingsView dans le Dashboard Stripe

Personnaliser la page des paramètres

Remplissez la page vide des paramètres de votre application en définissant une vue des paramètres et en élaborant une interface utilisateur afin de permettre à vos utilisateurs de configurer votre application.

Vous pouvez personnaliser la page des paramètres de votre application à votre guise. En mode aperçu, la page des paramètres est plus petite. En mode production, elle s’affiche en plein écran.

Ajouter une vue des paramètres

Définissez une vue des paramètres avec la CLI :

Command Line
stripe apps add settings

Donnez le nom de votre choix à votre composant. La vue des paramètres générée est disponible dans le répertoire src/views. Dans le manifeste de l’application, votre nouvelle vue est liée à la fenêtre d’affichage settings dans un champ ui_extension :

{ ..., "ui_extension": { "views": [ ..., { "viewport": "settings", "component": "AppSettings" } ], } }

Dans cet extrait de code, vous pouvez constater par vous-même qu’une vue est en réalité l’association d’un composant React et d’une fenêtre d’affichage donnée. Ici, le composant racine de la vue AppSettings apparaît dans la page des paramètres du Dashboard Stripe, à savoir la fenêtre d’affichage settings.

Le composant racine de la vue SettingsView n’est pas lié à un objet spécifique, mais à la fenêtre d’affichage settings, laquelle mappe vers des emplacements prédéfinis dans le Dashboard en dehors du volet d’applications.

Afficher un aperçu de votre page des paramètres

Lors de la prévisualisation de votre application en local, testez votre SettingsView à l’adresse https://dashboard.stripe.com/apps/settings-preview pour voir à quoi ressemblent les paramètres.

Une fois votre application chargée, votre SettingsView s’affiche sur la page des paramètres de l’application du Dashboard. Pour la voir en mode production, accédez à https://dashboard.stripe.com/settings/apps/YOUR_APPLICATION_ID et remplacez YOUR_APPLICATION_ID par l’ID que vous avez indiqué lors de la création de votre application.

Enregistrer les valeurs

Lorsqu’un utilisateur configure ses paramètres, votre application doit ensuite appliquer les modifications. Fournissez une fonction pour transmettre le composant SettingsView et gérer l’événement d’enregistrement. Un clic sur le bouton Enregistrer déclenche cet événement d’enregistrement.

La fonction de rappel onSave reçoit un objet de values. Cet objet transforme les éléments du formulaire en paires clé-valeur, dans lesquelles l’attribut name de l’élément est la clé et l’attribut value est la valeur :

/** * An example app settings view that provides two settings fields of first & last name. * The fields are combined into a single string value and passed to an external API. */ import {SettingsView, TextField} from "@stripe/ui-extension-sdk/ui"; const ExampleAppSettings = () => { // Define a callback function to pass to the onSave event. const saveSettings = async (values: any) => { try { // Extract our fields from the values object. The key is the name attribute of the form element. const { firstname, lastname } = values; // Make a POST request to an external API const result = await fetch( 'https://www.my-api.com/', { method: 'POST', body: JSON.stringify({ fullName: `${firstname} ${lastname}`, }), } ); await result.text(); } catch (error) { console.error(error); } }; return ( /* Assign our callback function to the onSave property */ <SettingsView onSave={saveSettings}> { /* A name attribute for each field is required to handle the form data in the onSave callback */ } <TextField name="firstname" label="First name" /> <TextField name="lastname" label="Last name" /> </SettingsView> ); }; export default ExampleAppSettings;

Pour en savoir plus, consultez la documentation consacrée à SettingsView.

Enregistrer et récupérer des paramètres

Pour gérer le stockage et la récupération des valeurs des paramètres, connectez le composant SettingsView à un back-end d’application ou à un service tiers qui inclut les paramètres d’application.

Consultez un exemple d’interface utilisateur des paramètres.

Afficher un message de confirmation

Vérifiez que votre interface utilisateur avertit les utilisateurs que leur configuration a été enregistrée. Utilisez la propriété statusMessage pour afficher un message de confirmation lorsqu’un utilisateur clique sur le bouton d’enregistrement.

Exemple de SettingsView affichant un message d'état

Exemple de SettingsView affichant un message d’état.

Voici le code correspondant à cet exemple dans lequel une SettingsView génère un message d’état à gauche du bouton d’enregistrement :

import {useState} from 'react'; import {SettingsView, TextField} from "@stripe/ui-extension-sdk/ui"; /** * An example app settings view that provides two settings fields of first & last name. * The fields are combined into a single string value and passed to an external API. * The user is notified of the status of their settings form through the statusMessage property. */ const ExampleAppSettings = () => { // useState to track the status of the form. Changing the status value triggers a rerender. const [status, setStatus] = useState(''); // Define a callback function to pass to the onSave event. const saveSettings = async (values: any) => { // Update the form status with a loading message. setStatus('Saving...'); try { const { firstname, lastname } = values; const result = await fetch( 'https://www.my-api.com/', { method: 'POST', body: JSON.stringify({ fullName: `${firstname} ${lastname}`, }), } ); await result.text(); // Update the form status with a success message. setStatus('Saved!'); } catch (error) { console.error(error); // Update the form status with an error message. setStatus('There was an error saving your settings.'); } }; return ( // Assign our callback function to the onSave property & pass the current value of statusMessage <SettingsView onSave={saveSettings} statusMessage={status} > <TextField name="firstname" label="First name" /> <TextField name="lastname" label="Last name" /> </SettingsView> ); }; export default ExampleAppSettings;

Vous pouvez également créer vos propres conceptions pour communiquer des états aux utilisateurs de votre application à l’aide des composants d’interface utilisateur.

Voir aussi

  • Documentation de l’API Extension SDK
  • Composants d’interface utilisateur
  • Créer une interface utilisateur
Cette page vous a-t-elle été utile ?
OuiNon
Besoin d'aide ? Contactez le service Support.
Rejoignez notre programme d'accès anticipé.
Consultez notre log des modifications.
Des questions ? Contactez l'équipe commerciale.
LLM ? Lire llms.txt.
Propulsé par Markdoc