Ce guide est à destination de votre équipe technique, afin de vérifier l’impact de la mise à jour du 11/10/2023 sur votre intégration.
Cet article vous parlera des motivations à l’origine de ce ‘breaking change’.
Cet article vous parlera des grands principes de ces modifications.
Le point à retenir est le suivant :
- L’état métier est stable, intuitif et ne changera pas.
- L’état technique est sujet à évolution et nécessite de comprendre le fonctionnement interne de ProAbono.
#1 API Live
L’API Live est l’API utilisée pour interagir avec vos clients, cette vérification est sans doute la plus importante pour garantir une continuité de service et de souscription pour vos clients.
Objets
#1 Changement dans les endpoints :
- /V1/Subscription
- /V1/Subscriptions
L’objet abonnement retourne depuis le 10/08 le double état (état métier / état technique).
{ "Id": 42", ... "ReferenceCustomer": "123456", "Status": "Active", // Etat métier "StateSubscription": "ActiveDelayedTermination", // Etat technique ... }
#1 Changement dans les endpoints :
- /V1/Invoice
- /V1/Invoices
L’objet facture retourne depuis le 10/08 le double état (état métier / état technique).
{ "Id": 42", ... "Status": "Due", // Etat métier "StateInvoice": "DueAuto", // Etat technique ... }
Si vous effectuez actuellement des opérations selon ces états (StateSubscription | StateInvoice), vous devez vous appuyer à la place sur l’état métier (Status).
Vous trouverez la correspondance dans cet article et dans celui-là.
Les valeurs actuelles des états techniques seront modifiées globalement le 11/10/2023.
Les valeurs actuelles de états métier ne changeront pas.
#2 Webhooks
Objets
Les webhooks retournent depuis le 10/08 le double état (état métier / état technique) pour les ressources concernées :
- Invoice (facture)
- Subscription (abonnement)
- Customer (client)
Si vous effectuez actuellement des opérations selon ces états (StateInvoice | StateSubscription | StateCustomer), vous devez vous appuyer à la place sur l’état métier (Status).
Les valeurs actuelles des états techniques seront modifiées globalement le 11/10/2023.
Les valeurs actuelles de états métier ne changeront pas.
Retrouverez les correspondances dans ces articles :
#3 API BO (exports)
Objets
Les ressources concernées retournent depuis le 10/08 le double état (état métier / état technique) :
- Invoice (facture)
- Subscription (abonnement)
- Customer (client)
- Payment (paiement)
Requêtes
Si vous utilisez l’état technique dans les paramètres de vos requêtes GET, (ex: GET https://via.proabono.com/Finance/Invoices?StateInvoice=PaymentDue ) modifiez celles-ci pour utiliser l’état métier autant que possible.
Les valeurs actuelles des états techniques seront modifiées globalement le 11/10/2023.
Les valeurs actuelles de états métier ne changeront pas.
Le tableau ci dessous vous donnera la correspondance :
Avant | Après | Correspondance |
?StateCustomer= | ?StatusCustomer= | https://docs.proabono.com/fr/documentation/clients/etats-client/ |
?StateInvoice= | ?StatusInvoice= | https://docs.proabono.com/fr/documentation/factures/etats-facture/ |
?StateInvoiceMin= | ?StatusInvoice= | utiliser l’état métier au lieu d’une plage d’états techniques |
?StateInvoiceMax= | ?StatusInvoice= | utiliser l’état métier au lieu d’une plage d’états techniques |
?StateSubscription= | ?StatusSubscription= | https://docs.proabono.com/fr/documentation/abonnements/etats-abonnement/ |
?StateSubscriptionMin= | ?StatusSubscription= | utiliser l’état métier au lieu d’une plage d’états techniques |
?StateSubscriptionMax= | ?StatusSubscription= | utiliser l’état métier au lieu d’une plage d’états techniques |
?StatePayment= | ?StatusPayment= | https://docs.proabono.com/fr/documentation/paiements/ |
#4 Zapier / Make
Objets
Les ressources concernées retournent depuis le 10/08 le double état (état métier / état technique) :
- Invoice (facture)
- Subscription (abonnement)
- Customer (client)
Si vous utilisez l’état technique dans vos workflows, modifiez-les pour utiliser l’état métier autant que possible.
Les valeurs actuelles des états techniques seront modifiées globalement le 11/10/2023.
Les valeurs actuelles de états métier ne changeront pas.
Reportez-vous au #3 API BO (exports) pour le tableau de correspondance.
Assistance
Si vous rencontrez des cas qui semblent difficiles à gérer par rapport à votre intégration, n’hésitez pas à contacter notre équipe support en vous connectant à ProAbono et en utilisant la messagerie en ligne.