Cet article présente les étapes de génération et de téléchargement des ordres de travail à l'aide de l'API Scantrust. Le jeton UAT doit disposer des autorisations suivantes :
- scans_download
Important:
Pour accéder à l'API REST Scantrust, vous pouvez utiliser une plateforme d'API comme Postman. Il s'agit de la plateforme d'API la plus populaire au monde, avec plus de 17 millions d'utilisateurs et 500 000 organisations dans le monde. Cet outil offre un environnement flexible et collaboratif qui vous permet de concevoir, développer, documenter et tester vos API plus rapidement.
Vous pouvez essayer l'application Web ou télécharger et installer cette application à partir de ce lien: https://www.postman.com/downloads/ Dans tous les cas, vous devez vous inscrire avec une adresse email valide.
Remarque : Dans le contexte de Scantrust, Postman ne doit être utilisé qu'à des fins de test. Il ne doit pas être utilisé dans des scénarios réels ni pour des déploiements de projets.
Étapes pour configurer Postman
1. Ouvrez Postman. Sur la page d'accueil, vous devriez voir ce qui suit:
2. Cliquez ensuite sur l’onglet « Espaces de travail », dans le coin supérieur gauche:
3. Cliquez ensuite sur l’option « Mon espace de travail » :
4. Une fois dans votre espace de travail, cliquez sur le signe « + » comme suit :
5. Après cela, un nouvel onglet apparaîtra avec une requête API préconfigurée : GET :
6. Il est maintenant important de configurer l'autorisation API. Pour cela, cliquez sur l'onglet « Autorisation » :
7. Ensuite, cliquez sur la section « Type » et sélectionnez l'option « Clé API », comme suit :
8. Maintenant, tapez le mot « Autorisation » dans le champ clé, puis copiez votre jeton UAT depuis le portail ST et collez-le dans le champ « Valeur », y compris les caractères UAT.UAT [jeton tu], en laissant une barre d'espace entre la chaîne UAT et le jeton :
9. Ensuite, allez dans l'onglet « Corps », sélectionnez « raw » et sélectionnez « JSON » :
Étapes pour télécharger les données numérisées
Pour télécharger vos données de numérisation, vous avez besoin de :
- Trouver l'ID de la campagne
- Définissez la période de temps pour filtrer les analyses en fonction d'une plage horaire.
Comment trouver votre identifiant de campagne :
1. Connectez-vous au portail et cliquez sur CAMPAGNES dans le menu hamburger sur la gauche.
2. Dans la campagne dont vous souhaitez télécharger les données, cliquez sur l'icône TABLEAU DE BORD :
3. Lorsque le panneau s'ouvre, l'URL dans le navigateur s'affiche :
https://portal.scantrust.com/#/dashboard?tabIndex=0&campaignId=126&page=1
L'ID de la campagne est en gras.
4. Ensuite, vous devez filtrer les informations à télécharger. Tous les filtres du tableau de bord peuvent également être utilisés pour filtrer les analyses téléchargées. Par exemple, si vous souhaitez filtrer et télécharger toutes les analyses decampagne 195,qui ont été marquéshors du marchéet qu'est-ce qu'ils ontmarché attendu établien "Chine" (Zh). Pour ce faire, vous devez configurer une requête GET avec l'URL suivante :
5. Vous devriez alors obtenir une réponse 200 OK:
Commentaires