Éligibilité
GTAF MAY peut émettre la demande d'éligibilité suivante pour vérifier si un utilisateur peut souscrire un forfait.
GET DPA/{userKey}/Eligibility/{planId}?key_type={CPID,MSISDN}
Notez que planId
est l'identifiant unique du forfait qui peut être utilisé pour l'acheter au nom de l'utilisateur (voir Achat de données).
Si planId
n'est pas spécifié, le DPA DOIT renvoyer tous les forfaits que l'utilisateur peut acheter.
La section Cas d'erreur liste les réponses attendues de la DPA en cas d'erreur. De plus, le DPA DOIT renvoyer une erreur dans les cas suivants :
- Le DPA renvoie un code d'erreur 400 BAD REQUEST indiquant à GTAF que
planId
n'est pas valide. - Le DPA renvoie un code d'erreur 409 CONFLICT indiquant que
planId
est incompatible avec le forfait de données de l'utilisateur.
Sinon, le DPA DOIT renvoyer une réponse 200-OK. Le format d'une EligibilityResponse réussie est le suivant :
{
"eligiblePlans":
[
{
"planId": string, // Plan identifier. Can be used to
// refer to the plan during
// offers, etc. (req.)
}
]
}
Lorsque la requête inclut un planId
, la réponse n'inclut que ce forfait. Sinon, la liste inclut tous les forfaits que l'utilisateur peut acheter. Si planId
est vide et que le DPA ne permet pas de renvoyer la liste des forfaits éligibles, il DOIT renvoyer une erreur 400 BAD REQUEST.
Expériences 5G sur Android
GTAF permet aux opérateurs de partager l'état de la mesure par type de connexion pour les abonnés. Les informations peuvent être extraites périodiquement par GTAF ou les opérateurs peuvent les envoyer en fonction de déclencheurs internes.
API Pull
L'appareil peut extraire les informations sur la connexion mesurée via GTAF en utilisant les éléments suivants :
GET DPA/{userKey}/planStatus?key_type={userKey}&client_id=AndroidSystemInfo
Notez que DPA (Data Plan Agent) représente une passerelle d'API ou un serveur d'autorisation dans le réseau de l'opérateur.
userKey est le jeton d'authentification établi lors de la phase d'authentification initiale, comme défini ici.
client_id est AndroidSystemInfo
L'état de mesure est fourni sous la forme d'un ENUM.
Le DPA doit renvoyer une réponse 200 OK et inclure planInfoPerClient. La gestion des erreurs pour le DPA est définie ici.
Dans le modèle pull, GTAF agit en tant que client et valide le certificat SSL du DPA. GTAF s'authentifie auprès de DPA à l'aide de la procédure OAuth définie ici.
API Push
L'opérateur peut également envoyer les informations sur la mesure de l'utilisation en fonction d'un événement déclencheur (par exemple, un changement de forfait).
POST https://mobiledataplansharing.googleapis.com/v1/operators/12345/clients/AndroidSystemInfo/users/abcdef/planStatus
Le DPA doit inclure planInfoPerClient dans le corps du message. Les réponses d'erreur de GTAF sont définies ici.
En mode Push, GTAF authentifie les requêtes entrantes du DPA à l'aide du serveur Google Cloud OAuth2. Les requêtes entrantes doivent être authentifiées en tant que compte de service figurant sur la liste d'autorisation du portail FAI pour l'ASN que représente le DPA. Pour en savoir plus, consultez également le guide d'intégration ici.