Aide à la caisse
Présentation de l'outil d'aide à la caisse dans Billwerk+.
Vue d'ensemble
L'outil Checkout Helper de Billwerk+ est une ressource facultative mais puissante, conçue pour aider les développeurs à comprendre et à utiliser l'API Session. Bien qu'il ne soit pas obligatoire, il constitue un excellent point de départ pour apprendre à construire des requêtes API sûres et efficaces pour créer des fenêtres de paiement.
Qu'il s'agisse d'intégrer des paiements uniques, une facturation récurrente ou la gestion d'un abonnement, le Checkout Helper sert d'outil d'apprentissage pratique, donnant un aperçu de la structure et des fonctionnalités de l'API Billwerk+ Session.
Vous pouvez naviguer en cliquant sur Configurations > Intégrations et outils > Checkout helper dans la barre latérale.
Pourquoi utiliser le Checkout Helper ?
L'API Sessions permet de créer des fenêtres de paiement sécurisées et personnalisables. Avant d'ouvrir une fenêtre de paiement, un appel à l'API est nécessaire pour créer une session de paiement, garantissant un échange de paramètres sécurisé pour des détails tels que les montants des paiements, les méthodes de paiement acceptées et les informations sur le client.
Pour les développeurs qui ne sont pas familiarisés avec l'API ou qui cherchent à affiner leurs demandes, le Checkout Helper est un moyen utile :
Comprendre la structure de la demande: Voir comment les différents champs correspondent aux paramètres de l'API.
Expérimentez les configurations: Essayez différents paramètres et voyez instantanément comment ils affectent la requête générée.
Valider les appels à l'API: Assurez-vous que vos appels sont correctement structurés avant de les mettre en œuvre.
Quand utiliser l'assistant de paiement
Le Checkout Helper est idéal pour les étapes initiales de votre parcours d'intégration, comme par exemple :
Apprendre l'API de session :
Si vous ne connaissez pas Billwerk+ ou les API en général, cet outil simplifie le processus de compréhension des paramètres et de la structure requis.
Prototypage et essais :
Configurez et prévoyez rapidement des appels API pour tester différents types de sessions ou combinaisons de paramètres.
Problèmes de débogage :
Utilisez l'outil pour vérifier vos appels API existants et identifier les problèmes potentiels.
Que pouvez-vous faire avec le Checkout Helper ?
Le Checkout Helper prend en charge trois types de sessions de paiement, alignés sur les fonctionnalités de l'API Session :
Session d'accusation :
Traiter un paiement unique.
Stocker éventuellement la méthode de paiement en vue d'une utilisation ultérieure (par exemple, paiements récurrents ou par abonnement).
Session récurrente :
Mémoriser un mode de paiement pour l'utiliser ultérieurement dans le cadre de transactions ou d'abonnements récurrents.
Session d'abonnement :
Modifier le mode de paiement d'un abonnement existant.
Activer un abonnement et le lier à une méthode de paiement.
Chaque type de session correspond à un point d'accès spécifique de l'API Session, et l'outil vous aide à élaborer la demande appropriée à vos besoins.
Principales caractéristiques de Checkout Helper
Champs préconfigurés : Les champs essentiels tels que les clés API, les montants, les devises et les détails sur les clients sont disponibles pour une saisie rapide.
Génération de requêtes en temps réel : Observez comment l'outil construit dynamiquement la charge utile de la requête JSON en fonction de vos données.
Configuration guidée : L'outil fournit un contexte et des descriptions pour chaque paramètre, vous aidant à comprendre son rôle dans l'appel API.
Exécution de la session : Testez vos configurations directement à partir de l'interface et voyez les réponses renvoyées par l'API.
Comment utiliser l'assistant de paiement
1. Accéder à l'outil
Ouvrez l'assistant de paiement dans l'interface de Billwerk+.
2. Sélectionnez le type de session
Choisissez entre les types de sessions payantes, récurrentes ou d'abonnement en fonction de votre cas d'utilisation.
3. Remplir les champs
Configurez la session en entrant des détails tels que :
Clé API pour l'authentification.
Locale et Devise pour la personnalisation régionale.
Montant de la commande et Détails de la commande pour les spécificités de la transaction.
Informations sur les clients et préférences en matière de méthodes de paiement.
4. Examiner la demande d'API
La demande générée est affichée en temps réel, ce qui vous permet de la valider et d'en comprendre la structure.
5. Test et ajustement
Testez la création de la session pour voir comment l'API répond. Ajustez les paramètres si nécessaire pour affiner votre demande.
Avez-vous besoin de l'assistant de caisse ?
Le Checkout Helper est entièrement facultatif. Si vous êtes sûr de votre compréhension de l'API Session et que vous préférez travailler directement dans votre environnement de développement, vous pouvez ne pas utiliser cet outil. Cependant, il peut vous faire gagner du temps et réduire le nombre d'erreurs, en particulier lors de la phase d'installation initiale.
Avantages de l'utilisation du Checkout Helper
Apprenez plus rapidement : Obtenez une expérience pratique de l'API de session dans un environnement guidé.
Réduire les erreurs : Créez des demandes précises et sûres en toute confiance.
Accélérer l'intégration : Passez moins de temps à résoudre les problèmes et plus de temps à développer.
Conclusion
Le Checkout Helper de Billwerk+ est une ressource pratique pour les développeurs qui cherchent à maîtriser l'API Session. Bien qu'il ne s'agisse pas d'une étape obligatoire de votre processus d'intégration, c'est un outil utile pour apprendre, tester et valider vos demandes d'API. Utilisez-le pour rationaliser votre flux de travail et garantir le bon fonctionnement de vos fenêtres de paiement.