Intégration – Synchroniser votre service avec ProAbono (3/5)

Cette série d’articles donne les best practices pour intégrer ProAbono. Transmettez-la à votre équipe technique si vous voulez une intégration pérenne, qui vous permette de créer des offres et des abonnements à la volée sans assistance technique.

<< Chapitre 1
< Chapitre précédent : Implémenter la synchronisation des droits avec ProAbono

Chap 3. Mapper votre gestion de droits avec vos abonnements

Les Caractéristiques

Les Caractéristiques (Feature) sont la seule ressource à connaître pour gérer les droits.

Une Caractéristique permet de définir une variable qui sert à la fois à influencer le tarif d’un abonnement, mais aussi à déterminer des droits dans votre service.

On peut masquer une caractéristique si elle est utile pour libérer des droits mais qu’on ne souhaite pas la montrer au client.

À chaque caractéristique est associé une référence unique (ReferenceFeature) de votre choix.

Voir la documentation API

GET /v1/Usages?ReferenceCustomer=123456
{
  "Page": 1,
  "SizePage": 10,
  "Count": 3,
  "TotalItems": 3,
  "DateGenerated": "2018-02-08T17:00:29.28Z",
  "Items": [
    {
      "Id": 1797,
      "IsVisible": true,
      "ReferenceFeature": "Users",
      "TypeFeature": "Limitation",
      "ReferenceCustomer": "123456",
      "QuantityIncluded": 3,
      "QuantityCurrent": 4
    },
    {
      "Id": 1785,
      "IsVisible": true,
      "ReferenceFeature": "Quota",
      "TypeFeature": "Consumption"
      "ReferenceCustomer": "123456",
      "QuantityIncluded": 100,
      "QuantityCurrent": 357
    },
    {
      "Id": 5478,
      "IsVisible": true,
      "ReferenceFeature": "Premium-Access",
      "TypeFeature": "OnOff",
      "ReferenceCustomer": "123456",
      "IsIncluded": true,
      "IsEnabled": true
    }
  ]
}

Les types de caractéristiques

OnOff

• Valeur binaire
• exemple : accès à la section Premium

Consumption

• Valeur entière positive
• Représente une consommation : un volume qui est remis à zéro périodiquement
• exemple : un quota, un nombre de SMS envoyés mensuellement

Limitation

• Valeur entière positive
• Représente un volume persistant dans le temps
• exemple : le nb d’utilisateurs

Ces spécifications suffisent à gérer les droits dans n’importe quel service. Vous ne voyez pas comment couvrir vos besoins ? Vous voulez plus d’informations ? Contactez-nous

Utilisation

Pour les caractéristiques OnOff, l’API vous indiquera si elle est activée ou non.

Si plusieurs abonnements coexistent et que vous avez demandé une valeur combinée, alors la réponse sera ‘activée’, si au moins un abonnement a cette caractéristiques d’activée.

Pour les caractéristiques Limitation et Consommation, l’API vous indiquera la valeur connue.

Si le champ « QuantityCurrent » n’est pas indiqué, c’est que la quantité est illimité, enjoy !

Si plusieurs abonnements coexistent et que vous avez demandé une valeur combinée, alors la réponse sera la somme des valeurs pour chaque abonnement. Si un abonnement est en illimité, la réponse sera ‘illimité’.

Dans le prochain chapitre nous verrons comment requêter les droits par Client et par Caractéristique >