API REST

Gérer de grandes quantités d'informations à l'aide de l'interface utilisateur de l'application peut s'avérer chronophage. Vous pouvez utiliser les API REST comme alternative à l'interface graphique utilisateur pour réduire le temps requis pour gérer votre inventaire système et le contenu de votre catalogue des logiciels.

API REST pour l'extraction du jeton d'authentification

Important : Si vous souhaitez utiliser l'API REST lorsque vous n'êtes pas connecté à BigFix Inventory, vous devez spécifier le paramètre token pour chaque requête. Pour vérifier le jeton, connectez-vous à BigFix Inventory, survolez l'icône Utilisateur Icône utilisateur et cliquez sur Profil. Cliquez ensuite sur Afficher le jeton.

Le paramètre token n'est pas requis si vous êtes connecté à BigFix Inventory.

API REST pour l'extraction de la version BigFix Inventory

Si l'utilisation de demandes API uniques pour extraire les données d'un sous-ensemble d'ordinateurs sélectionné affecte peu les performances de BigFix Inventory, il n'en va pas de même pour l'extraction simultanée de données en bloc sur tous vos systèmes informatiques. Pour améliorer les performances d'une API REST, extrayez les données par blocs. Pour plus d'informations, voir : Remarques sur les API REST.

Restriction : N'utilisez pas l'API REST lors de l'importation car vous pourriez rencontrer un problème avec la connexion de base de données. Si le problème se produit, attendez la fin de l'importation et veillez à ce que le serveur BigFix Inventory soit opérationnel. Renouvelez ensuite l'appel API.

Langage de réponse de l'API

Le langage de réponse de l'API dépend des critères ci-dessous :
Lorsque l'utilisateur est authentifié
  • La langue du profil de l'utilisateur est définie sur la langue par défaut :
    • Si l'en-tête "Accept-Language" est défini dans la requête et que la langue est prise en charge dans BigFix Inventory, la réponse de l'API apparaît dans la langue définie. Si la langue n'est pas prise en charge dans BigFix Inventory, la réponse apparaît dans la langue de rétromigration.
    • Si la langue du navigateur est prise en charge dans BigFix Inventory, la réponse apparaît dans la langue sélectionnée. Si la langue du navigateur n'est pas prise en charge dans BigFix Inventory, la réponse apparaît en anglais.
  • La langue du profil de l'utilisateur n'est pas définie sur la valeur par défaut :
    • La réponse de l'API apparaît dans la langue du profil utilisateur sélectionnée.
Lorsque l'utilisateur n'est pas authentifié.
  • Si l'en-tête "Accept-Language" est défini dans la requête et que la langue est prise en charge dans BigFix Inventory, la réponse de l'API apparaît dans la langue définie. Si la langue n'est pas prise en charge dans BigFix Inventory, la réponse apparaît dans la langue de rétromigration.
  • Si l'en-tête "Accept-Language" n'est pas défini dans la requête, la réponse apparaît en anglais.
Remarque : Le paramètre de langue de rétromigration dépend de la langue que vous définissez dans le fichier de configuration, telle que la propriété pristine_installer_language dans config/lmt_settings.yml. Il doit être défini en tant que langue prise en charge. Lorsque la langue n'est pas prise en charge, la langue par défaut devient l'anglais.

Abréviations

Les abréviations suivantes sont utilisées dans la documentation relative à l'API REST :

HTTP
Hyper Text Transfer Protocol. HTTP version 1.1 est défini dans RFC 2616. Sauf mention contraire, l'utilisation du terme HTTP indique à la fois HTTP et HTTPS.
HTTPS
Hyper Text Transfer Protocol Secure, tel que défini dans RFC 2818
JSON
JavaScript™ Object Notation, tel que défini dans éCMA-262
REST
Representational State Transfer, tel que décrit à l'origine de manière informelle dans le document Architectural Styles and the Design of Network-based Software Architectures
URI
Uniform Resource Identifier, tel que défini dans RFC 3986, version préliminaire 5