Authentification
Chaque appel nécessite une clé. Une clé appartient à une association et possède ses propres droits.
Clés
Une clé ressemble à lb_live_ suivi de 32 caractères. Vous l'envoyez dans l'en-tête Authorization :
Authorization: Bearer lb_live_3xT9...Un administrateur crée les clés sous Paramètres → Clés API. La clé n'est affichée qu'une fois ; nous ne conservons qu'un hash et les douze premiers caractères, pour que vous la reconnaissiez dans la liste. Une clé perdue est perdue : créez-en une nouvelle et révoquez l'ancienne.
Une clé peut avoir une date d'expiration et être révoquée à tout moment. Une clé révoquée ou expirée renvoie invalid_api_key. Sur la même page, l'administrateur voit les derniers appels par clé ; ce journal est conservé 90 jours.
Jamais dans l'URL
Une clé dans la chaîne de requête, comme ?api_key= ou ?access_token=, est refusée avec api_key_in_url, même si la clé est valide. Une URL finit dans les journaux des serveurs, dans l'historique du navigateur et dans l'en-tête Referer envoyé à d'autres sites. Si c'est arrivé, révoquez la clé.
Droits
L'administrateur choisit les droits d'une clé lors de sa création. Ne donnez à chaque intégration que ce dont elle a besoin. Si un appel exige un droit que la clé n'a pas, vous recevez insufficient_scope avec le droit manquant dans detail.
| Droit | Ce que la clé peut en faire |
|---|---|
leden:lezen |
Consulter les membres, participants et relations |
leden:schrijven |
Ajouter et modifier des membres |
leden:gevoelig |
Consulter aussi la date de naissance, l'IBAN et le mandat |
groepen:lezen |
Consulter les groupes et commissions |
groepen:schrijven |
Ajouter des membres aux groupes et les en retirer |
evenementen:lezen |
Consulter les événements et inscriptions |
evenementen:schrijven |
Ajouter des inscriptions |
facturen:lezen |
Consulter les factures et paiements |
facturen:schrijven |
Créer et envoyer des factures |
La date de naissance et les coordonnées bancaires (date_of_birth et sepa) ne sont incluses qu'avec leden:gevoelig.
Les noms des droits sont en néerlandais, comme le reste de Ledenboek : leden signifie membres, groepen groupes, evenementen événements, facturen factures, lezen lire, schrijven écrire et gevoelig sensible.
Clés de test
Une clé d'une association d'exemple commence par lb_test_. Elle fonctionne à la même adresse et avec les mêmes endpoints qu'une clé live, avec deux différences :
- aucun e-mail ni aucune demande de paiement n'est envoyé, même quand vous créez une facture ;
- la limite est de 120 appels par minute au lieu de 600.
Les données d'une association d'exemple sont fictives : vous pouvez tout essayer.
Abonnement
L'API fait partie de l'abonnement de l'association. Sans abonnement valide, chaque appel renvoie subscription_required (statut 402). Dès que l'abonnement est régularisé, la même clé fonctionne à nouveau.
Langue des messages d'erreur
Les champs title et detail d'une erreur suivent l'en-tête Accept-Language : nl, en, de ou fr. Sans cet en-tête, vous recevez de l'anglais. Le champ type est identique dans toutes les langues.