Mises à jour des devises dans l'API Patreon

  • Mise à jour

Pour permettre aux créateurs de gagner des abonnés à l'échelle mondiale, nous donnerons bientôt aux contributeurs la possibilité de payer dans toutes les devises acceptées par Patreon, quelle que soit celle du créateur. Vous trouverez ci-dessous les mises à jour de la documentation pour les APIv1 et APIv2. Pour en savoir plus sur les devises proposées, veuillez consulter cet article du centre d'aide : Devises acceptées par Patreon.

 

APIv1


Pour garantir une transition tout en douceur aux développeurs utilisant l'API Patreon, nous améliorons la documentation sur l'attribut currency de l'APIv1, qui renvoie la devise de l'offre de soutien du contributeur. Notez que dans l'APIv1, l'attribut currency est renvoyé par défaut à la ressource contribution. Par exemple, les développeurs qui utilisent l'APIv1 verront currency: GBP pour la ressource contribution d'un contributeur payant 5 £ (GBP étant le code ISO de la devise livre sterling), et les attributs de la contribution existante, sous la forme : amount_cents: 500 .

Notez également que la ressource Pledge Event de l'APIv2 indique déjà currency_code, ce qui correspond à currency dans l'APIv1. 

En plus des mises à jour de la documentation de l'API, nous affichons un attribut status pour la ressource contribution de l'APIv1. Les développeurs utilisant l'APIv1 pour restreindre et/ou accorder l'accès aux avantages peuvent désormais vérifier si l'attribut status est valid (c.-à-d., status: valid) et référencer la relation reward (niveau) pour vérifier qu'un contributeur a bien payé sa contribution pour un niveau, indépendamment de la devise du contributeur et de celle du créateur. Cette approche évite de devoir comparer les montants des contributions au montant total dû pour un niveau, et évite ainsi les frais de gestion des taux de change. En pratique, vos requêtes de l'APIv1 ressembleront à l'exemple suivant :
 
code1.jpg
avec pour réponse :
code2.jpg

La réponse inclut la relation reward (niveau du créateur). Notez que status est un champ facultatif qui doit être demandé explicitement. Par ailleurs, les attributs par défaut ne sont pas renvoyés si vous faites explicitement une requête pour certains champs.
 


APIv2


Pour verrouiller l'accès aux avantages à l'aide de l'APIv2, nous recommandons aux développeurs d'utiliser la ressource Membre. Les développeurs peuvent vérifier les valeurs patron_status et  currently_entitled_tiers pour restreindre ou accorder l'accès aux avantages par niveau, indépendamment de la devise. Pour accéder à ces attributs, votre requête dans l'APIv2 sera saisie comme suit :
 
code3.jpg
Elle donnera une réponse similaire à celle illustrée ci-dessous :
codesnippet1.jpg
Notez que les niveaux supprimés ne sont pas renvoyés dans la relation currently_entitled_tiers.  Les développeurs utilisant l'APIv2 qui ont besoin d'accéder aux contributeurs abonnés à des niveaux supprimés peuvent référencer le PledgeEvent pour verrouiller l'accès aux avantages. Il n'existe pas d'équivalent dans l'APIv1. Les développeurs doivent donc effectuer une mise à niveau si l'accès aux informations des niveaux supprimés est un cas d'utilisation important pour eux.
 
Pour résumer, si vous utilisez l'attribut amount_cents sur les ressources Member, PledgeEvent ou Pledge, la valeur renvoyée est toujours dans la devise du contributeur, pas dans la devise du niveau d'avantages ni dans celle de la campagne. Les mises à jour présentées ci-dessus permettent aux développeurs utilisant l'APIv1 et l'APIv2 d'accorder l'accès aux avantages du créateur sans se soucier du fait que la devise du contributeur diffère de celle du créateur. Si vous avez besoin d'aide pour exploiter au mieux ces dernières mises à jour, rendez-vous sur docs.patreon.com.

Cet article vous a-t-il été utile ?

Merci pour vos commentaires !

Que s'est-il passé ?