Définitions

Application

Une application est un compte API ouvert pour vous par HelloAsso, vous permettant de réaliser des opérations d’API sur les organismes enregistrés dessus.

Organisme

Un compte associatif ou une fondation inscrit-e sur HelloAsso.

Action

Une action d’un contributeur sur la plateforme HelloAsso, susceptible de remonter dans votre application, à condition que celle-ci ait été effectuée sur un des organismes affiliés à celle-ci.
Exemples : un don, une adhésion, une inscription à une billetterie.

Paiement

Un paiement est une transaction monétique réalisée sur HelloAsso, au profit d’une campagne. Un paiement est toujours associé à une ou plusieurs actions. Sur une billetterie, les internautes peuvent par exemple inscrire plusieurs personnes en même temps, et/ou laisser un don en plus de leurs inscriptions. Ceci engendrerait donc la création d’un paiement associé à une ou plusieurs actions d’inscription, et le cas échéant, d’une action de don.

Campagne

Une campagne est une page créée par un organisme sur HelloAsso, permettant de présenter un projet de financement participatif, un formulaire d’adhésion ou une billetterie en ligne. Les contributeurs peuvent réaliser des actions sur une campagne : réaliser un don (unique ou mensuel), s’inscrire, adhérer.

Présentation générale

L’ensemble des interfaces HelloAsso sont exposées au travers d’une API accessible sur le domaine api.helloasso.com. Celle-ci est structurée suivant les principes REST : les ressources sont exposées sous forme d’url sur lesquelles des appels HTTP GET et POST permettent respectivement de récupérer et modifier les données concernées.

HelloAsso ouvre pour ses partenaires des comptes d’application sur son API. Des données d’authentification seront fournies par HelloAsso. Celles-ci vous permettront d’accéder aux ressources privées associées à votre application. Ces données d’authentification doivent être intégrées dans l’en-tête de tous les appels, via le champ Authorization. Tous les appels apis auront donc la forme :


    <VERB> https://api.helloasso.com/v3/chemin
    Header :
    Authorization : Basic <chaine de connexion>

La chaîne de connexion est l’encodage base64 de la chaîne « username :password » ,ainsi que spécifié dans le standard Basic access authentication :

https://en.wikipedia.org/wiki/Basic_access_authentication

Les ressources sont nommées de façon explicite et sont arrangées selon la typologie suivante.

  • organization : un organisme enregistré sur votre application.
  • campaign : une campagne enregistrée sur votre application.
  • action : un don, une adhésion ou une inscription réalisée sur une campagne.
  • payment : un paiement réalisé sur une campagne, correspond à une ou plusieurs actions.

Tous les appels en lecture sont réalisés via une requête http GET. Les appels réalisant un enregistrement d’une nouvelle ressource sont réalisés par une requête http PUT, les modifications sont réalisées en POST. Toutes les requêtes doivent être réalisées en https.


Retour