ProDon:Intégration aux formulaires de dons en ligne (version 4.7.3)
| Intégration aux formulaires de dons en ligne (version 4.7.3) |
Définition des 3 méthodes d’intégration possibles
1. Lien
La méthode d’intégration la plus simple vous permettant d’orienter vos donateurs sur vos formulaires de dons en ligne.
Utilisations typiques :
- Intégration à votre site web
- Envoi d’un lien par courriel
Particularités :
- Possibilité d’accéder à la liste de vos formulaires, ou d’accéder directement à un formulaire.
- Pas de programmation requise (ajout d’un hyperlien uniquement)
2. Lien avec envoi d’informations
Une intégration plus avancée permettant de préremplir un formulaire.
Utilisations typiques :
- Intégration à partir d’un microsite
- Inscription d’équipes / participants
- Don à une équipe/participant
- Campagnes virales
- Intégration à partir d’un organisme tiers
- Firme de télémarketing
- Firme de développement web
- Intégration à partir d’un système tiers
- Système maison (gestion de membres, finissants, …)
Particularités :
- Programmation requise (exemples fournis)
- Intégration simple par paramètres GET (crypté) ou par paramètres POST
- Possibilité d’envoyer les informations au formulaire afin de le remplir :
- Informations nominatives
- Informations sur la transaction (à l’exception des informations de cartes de crédit)
- Informations personnalisées du formulaire (ex : nom/ID d’équipe, questions spécifiques, etc.)
3. Lien avec envoi d’informations et récupération de la transaction
Cette intégration inclut les possibilités du « lien avec envoi d’informations » (voir méthode 2) tout en permettant de récupérer la transaction complétée.
Utilisations typiques :
- Intégration à partir d’un microsite en permettant la gestion d’un ou des objectifs
- Permettre au microsite ou à l’organisme tiers de suivre en temps réel la progression des dons
Particularités :
- Programmation requise (exemples fournis)
- Programmation additionnelle requise pour le « CallBack » (afin de recevoir les informations de la transaction en format XML)
Explications techniques
1. Lien
Format du lien :
https://www.jedonneenligne.org/ ou https://www.imakeanonlinedonation.org/ REP_ORG[_test][/FORM] REP_ORG[/test][/index.php?form=FORM]
Définition :
- REP_ORG : Répertoire de l’organisme sur JeDonneEnLigne ou IMakeAnOnlineDonation
- Pour ProDon 4.7.3.x (version 1.1.8 du site JDEL) :
- [/test] : Mode test actif (non spécifié = mode production)
- [/index.php?form=FORM] : Code du formulaire à appeler (non spécifié = liste des formulaires)
- Pour ProDon 5.x (version 2.x du site JDEL) :
- REP_ORG[_test] : Mode test actif (non spécifié = mode production)
- [/FORM] : Code du formulaire à appeler (non spécifié = liste des formulaires)
Exemples de liens :
- Liste des formulaires : https://www.jedonneenligne.org/logilys
- Formulaire GEN : https://www.jedonneenligne.org/logilys/GEN
- Formulaire GEN (mode test) : https://www.jedonneenligne.org/logilys_test/GEN
2. Lien avec envoi d’informations
Ce type d’intégration nécessite des capacités de programmation. Voir prototype fonctionnel :
- Pour ProDon 4.7.3.x (version 1.1.8 du site JDEL) :
- Pour ProDon 5.0.2.x (version 2.0.1 du site JDEL) :
- Pour ProDon 5.0.3.x (version 2.1 du site JDEL):
- Prototype à venir...
- Téléchargement des sources à venir.
Le prototype est déjà prérempli pour que vous puissiez essayer l’intégration en cliquant simplement sur « send data ».
Voici la liste des paramètres possibles dans le prototype :
- Clé : Clé de cryptage unique par organisme. Cette clé est générée par Logilys à la demande de l’organisme puis envoyée à l’intégrateur (s’il y a lieu).
- Répertoire : Répertoire de l’organisme sur JeDonneEnLigne. Ajoutez « /test » (ProDon 4.7.3.x) ou « _test » (ProDon 5.x) pour activer le mode test.
- FrmUID : Numéro du formulaire à utiliser pour l’envoi d’informations.
- Informations nominatives démontrées en exemple : Pays, Appellation, Prénom, Nom, Adresse, Ville, Province (FrmProvinceUID), Code Postal, Email, Téléphone résidence.
- Informations sur la transaction démontrées en exemple : Montant, Activité (FrmActUID), Mode de paiement (FrmPaiUID) et Reçu (FrmReceipt).
- Les différents paramètres « UID » sont spécifiques à l’organisme, mais peuvent être facilement trouvés en inspectant le code source du formulaire.
Vous pouvez aussi télécharger les sources complètes du prototype en cliquant sur « download sources ». Voici le contenu du fichier zip :
- integration_prototype.php : le code source du prototype
- integration_js_prototype.php : autre exemple, mais en java script
- encode64.js, mcrypt.js, rijndael.js : utilisé par integration_js_prototype.php
- list_parameters.txt : descriptions sommaires des paramètres possibles.
3. Lien avec envoi d’informations et récupération de la transaction
Voir au préalable les explications techniques du « lien avec envoi d’informations ». Cette intégration permet de récupérer la transaction par la suite.
Les informations sur la transaction vous seront transmises (POST) en format XML sur l’URL de votre choix (que vous devrez spécifier en paramètre lors de l’appel du formulaire).
Paramètres additionnels entrants à passer lors de l’appel au formulaire :
- PersonalUrl (crypté) : L’URL de votre callback, exemple : &PersonalUrl=http://www.monsite.com/jdel_callback.php (crypté)
- PersonalId (non crypté) : Identifiant unique pour votre transaction, exemple : &PersonalId=00000001 (non crypté).
Paramètres sortants envoyés sur votre « PersonalUrl » :
- trx_xml (crypté) : xml de la transaction. Voir le fichier « callback return xml example.txt » dans les sources du prototype pour un exemple
- mode (non crypté) : Contient « TEST » ou « PROD » selon si la transaction a été effectuée en mode test ou production
- PersonalId (non crypté) : Votre identifiant unique.
- Attention : Pour ProDon 4.7.3.x et 5.0.2.x (version 1.1.8 et 2.0.1 du site JDEL), l'appel est effectué sans « UserAgent »
Nom du document : ProDon:Intégration aux formulaires de dons en ligne (version 4.7.3)
