Effectuer l'appel d'API
Informations personnelles identifiables (PII) et données propriétaires dans les appels d'API
La visibilité de l'ensemble des informations personnelles identifiables (PII) et des données propriétaires peut être contrôlée à l'aide des paramètres suivants Vuforia :
|
Paramètre
|
Informations
|
||
|---|---|---|---|
|
Lorsque ce paramètre est désactivé, les déclarations suivantes sont vraies :
• Les informations sur la procédure (titre de la procédure, commentaires de l'utilisateur) sont retirées.
• Les informations sur l'étape (description de l'étape, titre, commentaires de l'utilisateur et retour d'information des médias) sont retirées.
• Les informations de l'utilisateur (prénom, nom, e-mail et rôle) sont retirées.
Ce paramètre est désactivé par défaut.
Lorsque ce paramètre est activé, les données ci-dessus ne sont pas retirées.
|
|||
|
Lorsque ce paramètre est activé, les données renvoyées sont affectées.
Ce paramètre est désactivé par défaut.
|
 |
Dans les cas où ces deux paramètres sont en conflit l'un avec l'autre, le retrait ou le raccourcissement de l'information prévaut.
|
Appel d'API
Vous pouvez effectuer des appels d'API à l'API /customer-events/<ID org>/report qui renverra les données de session d'une organisation spécifiée. Les résultats peuvent ensuite être filtrés à l'aide des paramètres de requête. Les paramètres de requête suivants peuvent être utiles :
• feedback
• serialNumber
• failures
• progress
Pour plus d'informations sur les paramètres ci-dessus, consultez la rubrique Paramètres disponibles.
 |
Pour obtenir de meilleurs résultats, les paramètres d'URL doivent être codés car certains caractères ne fonctionnent pas sans cela. Par exemple, si un numéro de série est 'serial$number#with|special&chars', la version codée qui est sécurisée et recommandée comme paramètre d'URL est 'serial%24number%23with%7Cspecial%26chars'.
|
Les exemples suivants sont disponibles :
Résultats paginés
Les réponses de l'API sont divisées en pages. Bien que la taille de la page puisse varier et ne soit pas garantie, elle inclut généralement environ 100 éléments.
Lorsque des pages supplémentaires sont disponibles, la réponse inclut un élément nextPagePostBody. Cet élément réplique les paramètres de la requête initiale à des fins de commodité et ajoute un pointeur vers la page suivante.
Pour récupérer la page suivante, soumettez une autre requête POST au même point de terminaison en utilisant nextPagePostBody comme corps de requête. Continuez jusqu'à ce que la réponse ne contienne plus d'élément nextPagePostBody.
Voici un exemple de sortie contenant l'élément nextPagePostBody :
{
"items": [ ... ]
...
"nextPagePostBody": {
"granularity": "step",
"progress": [
"completed",
"abandoned",
"ongoing"
],
"startTime": "2025-04-21T22:00:00.000Z",
"endTime": "2025-10-22T21:59:59.999Z",
"latestStepState": true,
"page": 2
}
}
Le prochain appel POST serait alors le suivant :
POST https://vuforia.portal.ptc.com/customer-events/<orgId>/report
{
"granularity": "step",
"progress": [
"completed",
"abandoned",
"ongoing"
],
"startTime": "2025-04-21T22:00:00.000Z",
"endTime": "2025-10-22T21:59:59.999Z",
"latestStepState": true,
"page": 2
}