💡 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 "Donateurs" Disponibles

Le Montant de son don
La devise
Le prénom
La ville
Le type de transaction (paiement ou engagement)

A noter :

Les autres informations donateurs stockées dans Rgive ne sont pas partagées via le flux API conformément aux recommandations de la CNIL afin de ne pas prendre de risque sur ces informations à caractère personnel.

🚀 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 flux, 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.

Attention : elle n’est disponible qu’une seule fois !

3. Configuration du Endpoint correspondant au flux cible

L’URL du point d’API est la suivante :

https://{{domaine_de_l_asso}}/api/private/latest-donors-feeds/{{id_du_flux}}/

⚠️ Le “/” de fin est important.

L’ID unique du flux dont vous voulez récupérer les informations est visible dans la page de configuration du Flux Derniers Donateur

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.QVssyNBl6uOHSyHThWpIVLrD593RquK" https://demo.rgive.com/api/private/latest-donors-feeds/88f08672-be07-4450-9df2-aa154f422/

Exemple de Réponse

{
  "uuid": "88f08672-be07-4450-9df2-aa154f422",
  "name": "Flux - Min 20 - Initiale du prénom",
  "icon_type": "initial",
  "items": [
    {
      "amount": 20,
      "currency": "EUR",
      "firstname": "Alain",
      "city": "Pessac",
      "type": "payment"
    },
    {
      "amount": 70,
      "currency": "EUR",
      "firstname": "Jimmy",
      "city": "Pessac",
      "type": "payment"
    },
    {
      "amount": 50,
      "currency": "EUR",
      "firstname": "Jimmy",
      "city": "Pessac",
      "type": "payment"
    },
    {
      "amount": 30,
      "currency": "EUR",
      "firstname": "Jimmy",
      "city": "Pessac",
      "type": "payment"
    },
    {
      "amount": 50,
      "currency": "EUR",
      "firstname": "Anne-Laure",
      "city": "Talence",
      "type": "payment"
    },
    {
      "amount": 30,
      "currency": "EUR",
      "firstname": "Anne-Laure",
      "city": "Talence",
      "type": "payment"
    },
    {
      "amount": 48,
      "currency": "EUR",
      "firstname": "Cyril",
      "city": "Talence",
      "type": "payment"
    },
    {
      "amount": 38,
      "currency": "EUR",
      "firstname": "Cyril",
      "city": "Talence",
      "type": "payment"
    },
    {
      "amount": 36,
      "currency": "EUR",
      "firstname": "Cyril",
      "city": "Talence",
      "type": "payment"
    },
    {
      "amount": 47,
      "currency": "EUR",
      "firstname": "Cyril",
      "city": "Talence",
      "type": "payment"
    }
  ]
}