1/ Gérez les droits d’accès
Les Caractéristiques (Feature) sont la seule ressource à connaître pour gérer les droits. Elles représentent un élément variable qui va influencer le tarif de l’abonnement et permet aussi de déterminer les droits d’accès à votre service.
Rappel des 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 : nombre de SMS envoyés mensuellement
Limitation
- Valeur entière positive
- Représente un volume persistant dans le temps
- exemple : nombre d’utilisateurs
À noter : on peut masquer une caractéristique si elle est utile pour libérer des droits, mais qu’on ne souhaite pas l’afficher au client.
À noter : chaque caractéristique est associée à une référence unique (ReferenceFeature) de votre choix.
Utilisation
GET /v1/Usages?ReferenceCustomer=123456
{
...
"Items": [
{
"Id": 5478,
"IsVisible": true,
"ReferenceFeature": "Premium-Access",
"TypeFeature": "OnOff",
"ReferenceCustomer": "123456",
"IsIncluded": true,
"IsEnabled": true
},
{
"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
}
]
}
Pour en savoir plus sur la requête, consultez la documentation API dédiée
L’interprétation des données dépend du type de la caractéristique :
- 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éristique activée.
- 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ée.
- 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é ».
-
Prochain chapitre : ajuster les droits et la consommation par API >