Commande HB_API_GET

Envoie une requête GET à l'API HighBond.

Syntaxe

HB_API_GET URL_demande_API_HighBond HEADERS informations_en-tête PASSWORD num TO fichier_réponseHighBond_API_request_URL

Paramètres

"https://apis-us.highbond.com/v1/orgs/11594/robots"

'{"content-type": "application/vnd.api+json"}'

TO "response.json"

TO "C:\HighBond API responses\response.json"

Exemples

HB_API_GET "https://apis-us.highbond.com/v1/orgs/11594/robots" HEADERS '{"content-type": "application/vnd.api+json"}' TO "all_robots.json"

HB_API_GET "https://apis-us.highbond.com/v1/orgs/11594/robots" HEADERS '{"content-type": "application/vnd.api+json"}' TO "C:\HighBond API responses\all_robots.json"

{
  "data": [
    {
      "id": "17504",
      "type": "robots",
      "attributes": {
        "active_app_version": 4,
        "app_versions_count": 5,
        "name": "Concur T&E Data Integration",
        "category": "acl",
        "drive_system_user": "exYRZqYABvrjHCjV7E7j"
      }
    },
    {
      "id": "24202",
      "type": "robots",
      "attributes": {
        "active_app_version": 2,
        "app_versions_count": 2,
        "name": "Test_Steele_Adverse_Media",
        "category": "highbond",
        "drive_system_user": "exYRZqYABvrjHCjV7E7j"
      }
    }
  ]
}

COMMENT
//ANALYTIC Échantillonnage de la Requête de l'API HighBond			
//PASSWORD 1 Jeton d'API HighBond :				
//RESULT FILE all_robots.json				
END		
				
HB_API_GET "https://apis-us.highbond.com/v1/orgs/11594/robots" HEADERS '{"content-type": "application/vnd.api+json"}' PASSWORD 1 TO "all_robots.json"

HB_API_GET "robots" TO "all_robots.json"

Remarques

Création d'une définition de mot de passe et spécification d'une valeur de mot de passe

Lorsque vous exécutez un script dans Robots qui envoie une requête à l'API HighBond, vous devez inclure une définition de mot de passe avec la commande qui envoie la requête. La même condition requise s'applique aux scripts exécutés dans Analytics si vous avez utilisé l'activation hors connexion.

Quelle que soit la méthode que vous utilisez pour créer la définition de mot de passe, la valeur de mot de passe requise est un jeton d’accès à Diligent One, que vous pouvez générer dans Barre de lancement. Pour plus d'informations, consultez la rubrique Obtenir un jeton d’accès Diligent One.

Méthodes de définition de mot de passe

Obtenir un jeton d’accès Diligent One

Utilisez un jeton d'accès existant sauf si vous avez une bonne raison d'en créer un nouveau. Si le jeton existant ne fonctionne pas, créez-en un nouveau. L'utilisation d'un jeton existant réduit le nombre de jetons que vous devez gérer.

1. Effectuez l'une des actions suivantes :

   • Dans le menu principal d’Analytics, sélectionnez Outils > Jeton d’accès à Diligent One.

   • Dans l’Éditeur de script, cliquez avec le bouton droit de la souris, puis sélectionnez Insérer > Jeton Diligent One.

   La page Gérer des jetons API s'ouvre dans votre navigateur. Il est possible que vous deviez d'abord vous connecter à Diligent One.

   L'accès à la page Gérer des jetons API via Analytics est une fonctionnalité d'ordre pratique. Vous pouvez également vous connecter à Diligent One et accéder à la page via votre profil utilisateur sans passer par Analytics.

2. Effectuez l'une des actions suivantes :

   • Utiliser un jeton existant

     1. Dans la colonne Jeton, cliquez sur le jeton en partie masqué que vous voulez utiliser.

     2. Saisissez le mot de passe de votre compte Diligent One et cliquez sur Confirmer.Diligent One

        Le jeton démasqué s'affiche.

     3. Cliquez sur Copier pour copier le jeton.

        Astuce

        Ne fermez pas la boîte de dialogue contenant le jeton tant que vous n'avez pas fini de copier-coller le jeton.

   • Créer un nouveau jeton

     1. Cliquez sur Ajouter un jeton > Analytics.

     2. Dans le panneau latéral Nouveau jeton Analytics, indiquez les informations suivantes :

        Champ ou option	Description
        Description	Saisissez une description qui fournit des informations utiles, telles que : L'objet du jeton L'emplacement d'utilisation du jeton : par exemple, le nom et l'emplacement du script Analytics, ou le nom et l'emplacement des tâches du robot
        Expiration du jeton	Activée le jeton expire au bout du nombre de jours que vous avez spécifié Désactivée le jeton n'expire pas Remarque Votre organisation dispose peut-être d'une politique de sécurité qui demande à ce que les jetons expirent au bout d'un certain temps. Créer des jetons avec une date d'expiration est une bonne pratique. Diligent One vous envoie une notification automatique par e-mail quelques jours avant la date d'expiration.
        Expire dans	Indiquez le nombre de jours avant l'expiration du jeton (de 1 à 365)
        Mot de passe	Saisissez le mot de passe de votre compte Diligent One.

     3. Cliquez sur Générer un jeton.

     4. Cliquez sur Copier pour copier le jeton.

        Astuce

        Ne fermez pas le panneau latéral contenant le jeton tant que vous n'avez pas fini de copier-coller le jeton.

3. Selon la méthode de définition de mot de passe utilisée, effectuez l'une des actions suivantes :

   • Balise d'analyse de données PASSWORD Dans leConcepteur de tâches d'un robot ACL, collez le jeton copié dans un champ de paramètre de mot de passe.ACL robot

   • Commande PASSWORD Dans Analytics, collez le jeton copié dans l'invite de mot de passe qui apparaît lors de l'exécution du script.Analytics

   • Commande SET PASSWORD Dans Analytics, collez le jeton copié à l'endroit approprié dans la syntaxe de la commande SET PASSWORD dans un scriptAnalytics

4. Dans la barre de lancement, fermez la boîte de dialogue ou le panneau latéral contenant le jeton.

   Si vous avez créé un nouveau jeton, une version partiellement masquée du jeton est ajoutée en haut de votre liste de jetons.

   Pour plus d’informations, consultez la rubrique Créer et gérer des jetons d’accès Diligent One.