💡 Cas d'Usage : soirées de gala, évènement sportif, week-end de mobilisation, etc.
En tant qu’association ou agence, vous pouvez pouvoir récupérer les information de collecte d'une ou plusieurs campagnes afin de les afficher sur une page ou une app tierces développées pour l'occasion.
ℹ️ Informations disponibles
Le point d’API qui va être activé va vous permettre de récupérer différentes données qui concerne la collecte et les derniers donateurs.
⏱️ Information "Compteur" Disponibles
Total de dons ponctuels réussis
Total de dons ponctuels promis
Total de dons ponctuel (i.e. réussis + promis)
Total de dons réguliers réussis
Total de dons réguliers promis
Total de dons réguliers (i.e. réussis + promis)
Total global
Paramétrage du compteur :
Volumes initiaux
Objectifs,
Devise, etc.
A noter :
Les totaux sont à la fois disponibles en montant et en nombre de contributeurs.
Ces détails respectent le paramétrage du compteur : donc les totaux restent nuls si le type de paiement correspondant n’est pas coché dans le compter et que celui-ci ne les comptabilise donc pas.
Les promesses confirmées sont comptées une seule fois comme “réussi”.
👥 Information "Derniers Donateurs" Disponibles
En cours de développement
🚀 Activation et Branchement
Activation par RGIVE
Afin de pouvoir accéder aux données disponibles sur votre instance, il est nécessaire que la fonctionnalité soit activé par RGIVE. Pour cela, nous vous invitons à contacter l'équipe Customer Sucess en créant un ticket.
2. Création de la Clé API
Afin d'appeler le endpoint du compteur, il faut générer une clé.
Allez dans Sécurité > Clés API (A noter : il est nécessaire que les droits qui vous sont attribués vous y autorisent) puis "Ajouter une clé API"
⚠️ Si le besoin de récupération des informations est ponctuel et géré par une entreprise ou agence tierces, au moment de créer la clé, nous vous invitons à lui donner une date d'expiration.
La clé est à récupérer dans le message de confirmation en haut de l'écran.
Attention : elle n’est disponible qu’une seule fois !
3. Configuration du Endpoint correspondant au compteur cible
L’URL du point d’API est la suivante :
https://{{domaine_de_l_asso}}**/api/private/live-counters/{{id_du_compteur}}/
⚠️ Le “/” de fin est important.
L’ID du compteur dont vous voulez récupérer les informations est visible dans la page de configuration du compteur
La clé doit être fournie lors de l'appel API dans l’entête X-RGIVE-API-KEY
📞 Exemples d'Appel et de Réponse
Exemple d'Appel
curl -H "X-RGIVE-API-KEY: j4GToaGS.QVssyNBl6uOHSyHThWpIVLrD593RquKqfm" http://client.asso.fr/api/private/live-counters/574152a7-ab1c-4bcd-995e-36e63c449391/
Exemple de Réponse
{
// Id du compteur
"uuid": "574152a7-ab1c-4bcd-995e-36e63c449391",
// Objectif de montant / de contributeurs
"amount_goal": null,
"contributors_goal": 2500,
// Devise "currency":
"EUR",
// Date de début de fin de la collecte
"start_datetime": "2024-12-03T00:01:00+01:00",
"deadline": "2024-12-03T23:59:00+01:00",
// Comptes détaillés : ils peuvent être nuls si le type de paiement n'est pas comptabilisé dans les paramètres du compteur dans ce cas ils ne sont pas non plus inclus dans les totaux "counts":
// Montant initiaux saisis manuellement
"initial": {
"amount": 0,
"contributors": 0 },
// Dons ponctuels online réussis
"oneoff_succeeded": {
"amount": 199545,
"contributors": 2047 },
// Promesses de dons ponctuels
"oneoff_pledged": null,
// Totaux dons ponctuels (réussis + promesses)
"total_oneoff": {
"amount": 199545,
"contributors": 2047 },
// Dons réguliers online réussis
"regular_succeeded": null,
// Promesses de dons réguliers
"regular_pledged": null,
// Totaux dons réguliers (réussis + promesses)
"total_regular": null,
// Totaux généraux (dons ponctuel et réguliers, incluant les promesses) "total": {
"amount": 199545,
"contributors": 2047 },
// % de progression par rapport à l'objectif
"progress": 81 } }ℹ️ Les valeurs null dans l’exemple (objectif de montant, comptage des dons réguliers) correspondent à des éléments désactivés dans la configuration du compteur.