Skip to content

Latest commit

 

History

History
62 lines (49 loc) · 3.06 KB

README.md

File metadata and controls

62 lines (49 loc) · 3.06 KB

La fonctionnalité checkout (anciennement appelée prefill) permet aux association d'utiliser HelloAsso comme solution de paiement simple. Cela nécessite que l'association gère de son côté la partie "panier".

Cette utilisation est réservée aux associatons ayant pris contact avec notre équipe commerciale, qui se chargera d'initier le setup en interne et de communiquer la documentation.

Fonctionnement

Ce repo contient un site d'exemple PHP permettant de réaliser un paiement via le checkout puis de revenir sur le site initial.

La page principale représente un panier prérempli et personnalisable, un formulaire de saisie de coordonnées et un récapitulatif. Il peut être intégré très facilement avec un minimum de personnalisation.

Très concrètement cela donne ce fonctionnement:

alt text

Il est organisé selon le pattern MVC et utilise AltoRouter pour le routage des requêtes. Les échanges avec HelloAsso se font au travers d'un service qui prend la forme d'un wrapper d'API.

L'arborescence du projet est la suivante:

📦prefill-sample
 ┣ 📂Controllers
 ┃ ┗ 📜FormController.php      // Récupère les données du formulaire pour les passer au wrapper de l'api
 ┣ 📂Models
 ┃ ┗ 📜FormViewModel.php       // Transporte les données entre la vue et le contrôleur
 ┣ 📂Services
 ┃ ┗ 📜HelloAssoApiWrapper.php // Authentification et récupèration du lien vers le formulaire de paiement via l'API HelloAsso
 ┣ 📂Views
 ┃ ┣ 📜form.phtml              // Page principale affichant le panier et le formulaire de coordonnées
 ┃ ┗ 📜return.phtml            // Page s'affichant au retour du paiement
 ┣ 📂css
 ┃ ┗ 📜main.css
 ┣ 📂images
 ┃ ┣ 📜beer.jpg
 ┃ ┣ 📜chocolate.jpg
 ┃ ┗ 📜tree.jpg
 ┣ 📂js
 ┃ ┣ 📜address.js
 ┃ ┗ 📜form.js
 ┣ 📜Config.php                // À modifier selon votre environnement
 ┣ 📜composer.json
 ┗ 📜index.php

Configuration

L'ensemble de la configuration se fait dans le fichier Config.php.

public $clientId = "";                                // Votre API client id
public $clientSecret = "";                            // Votre API client secret
public $organismSlug = "";                            // Slug de votre association
public $baseUrl = "https://localhost:3000";           // A modifier en production
public $returnUrl = "https://localhost:3000/return";  // A modifier en production

Déploiement

Ce site nécessite d'avoir un environnement PHP ainsi que composer pour gérer les dépendances.

Avant de tester ou déployer ce site, il faut donc récupérer les dépendances:

composer install

Pour tester en local il est possible d'utiliser Visual Studio Code et l'extension PHP Server

Pour une utilisation en production, il suffit de copier l'intégralité du dossier sur votre serveur