Privilèges et Rôles 👑

Pour effectuer des appels API sur https://api.helloasso.com/v5 votre token doit posséder des privilèges et des rôles.

📘

Décomposer votre token

Pour décomposer votre token d'accès et regarder les détails qui le composent (privilèges, rôles, expiration ...) vous pouvez utiliser le site : https://jwt.io/

Rôles (qui êtes vous ?)

OrganizationAdmin

Vous permet d’appeler des points d’API pour récupérer des données sensibles d’une
association comme les paiements ou de créer certains types de formulaires.

• Si vous êtes une association et que vous utilisez une clé API générée depuis votre back office HelloAsso, le rôle OrganizationAdmin sera automatiquement attribué à votre token d'accès.
• Si vous êtes un partenaire, vous pourrez obtenir ce rôle via la mire d'autorisation, et donc une autorisation explicite d’une association à accéder à ses données. (voir la page Mire d’autorisation). Voir le fonctionnement de la mire d'autorisation

FormAdmin

Vous permet d’appeler des points d’API pour récupérer des données sensibles d’un
formulaire comme les paiements.

Privilèges (quels sont vos droits ?)

🚧

Clé partenaire uniquement

Seul les partenaires peuvent faire la demande pour avoir certain de ces droits lors de l'élaboration du partenariat avec HelloAsso.

Les associations ont uniquement les droits suivants par défaut : Checkout, AccessPublicData, AccessTransaction

AccessPublicData

Vous permet d’appeler des points d’API pour récupérer la donnée publique de HelloAsso
accessible sur le site.

FormOpenDirectory

Vous permet d’appeler des points d’API pour récupérer une liste précise de formulaires à
l’aide de filtres.

AccessTransactions

Vous permet d’appeler des points d’API pour récupérer les détails sur les transactions.

OrganizationOpenDirectory

Vous permet d’appeler des points d’API pour récupérer une liste d’associations avec des
filtres.

Checkout

Vous permet d’utiliser le type de formulaire checkout et de permettre aux contributeurs
d’effectuer des paiements, plus d’information sur ce document.

FormAdministration

Vous permet de créer rapidement des évènements avec les informations de base.

RefundManagement

Vous permet de déclencher le remboursement d’un paiement.
NB: Il n’est pas aujourd’hui possible de rembourser partiellement un paiement.