Configuration de l'API : Activation de l'API XML et configuration de champs personnalisés

Gestion > Configuration de l'API

API :: Configuration

Activer l'API XML

Vous pouvez choisir d'activer l'API XML Bomgar, qui permet d'exécuter des rapports et des commandes, tels que le démarrage ou le transfert de sessions depuis des applications externes, ainsi que de sauvegarder automatiquement votre configuration logicielle.

Autoriser l'accès HTTP à l'API XML

Par défaut, l'accès à l'API s'effectue via une connexion SSL cryptée. Vous pouvez néanmoins autoriser un accès HTTP non crypté. Il est fortement recommandé de désactiver l'accès HTTP dans le cadre des meilleures pratiques de sécurité.

Remarque : cette option est obsolète depuis la version 16.1 et n'apparaît pas pour les nouveaux utilisateurs. Pour les utilisateurs se mettant à jour depuis une version antérieure à 16.1, l'option est toujours disponible si vous continuez à utiliser la méthode obsolète d'authentification à l'API avec un compte d'utilisateur. Si vous passez à la méthode préférée d'authentification avec un compte API, tout le trafic API doit se faire en HTTPS.

API :: Comptes

Un compte API stocke tous les paramètres d'authentification et d'autorisation pour le client d'API. Au moins un compte d'API est nécessaire pour utiliser l'API, soit en conjonction avec le client d'intégration, soit avec une application tierce, soit avec votre propre logiciel.

Remarque : avant la version 16.1, un compte d’utilisateur était utilisé pour l’authentification à l’API. Cette méthode est désormais obsolète, mais elle est toujours prise en charge pour la rétrocompatibilité avec les clients qui l’utilisent.

Créer un nouveau compte d'API, Modifier, Supprimer

Créer un nouveau compte, modifier un compte existant, ou supprimer un compte existant.

API :: Compte :: Ajouter ou modifier

Nom

Créez un nom unique permettant d'identifier ce compte.

Commentaires

Ajoutez des commentaires pour aider à identifier la fonction de cet objet.

Activé

Si cette option est cochée, ce compte est autorisé à s’authentifier auprès de l’API. Lorsqu’un compte est désactivé, tous les jetons OAuth associés au compte sont immédiatement désactivés.

Autorisations

Sélectionnez les zones de l'API que ce compte a le droit d'utiliser. Pour l'API de commande, choisissez de refuser l'accès, d'autoriser l'accès en lecture seule ou d'autoriser l'accès complet. Définissez également si ce compte peut utiliser l'API de rapport, l'API de sauvegarde ou l'API du gestionnaire d'informations d'authentification de point de terminaison.

Restrictions de réseau

Répertoriez les préfixes d'adresse réseau à partir desquels ce compte peut s'authentifier.

Remarque : les comptes API ne sont pas restreints par les préfixes réseau configurés sur la page /login > Gestion > Sécurité. Ils sont uniquement restreints par les préfixes de réseau configurés pour le compte d'API.

Paramètres d'authentification

L’ID client Oauth et le secret de client sont utilisés pour créer des jetons OAuth, nécessaires pour l’authentification à l’API. Pour plus d’informations, consultez le Guide de l’API.

Identifiant client OAuth

L'ID client OAuth est un identificateur unique généré par le serveur. Il ne peut pas être modifié. L'ID client est considérée comme information publique et peut donc être partagée sans compromettre la sécurité de l'intégration.

Secret de client OAuth

Le secret de client OAuth est généré par le serveur grâce à un générateur de nombres pseudo-aléatoire sécurisé cryptographiquement.

Remarque : le secret de client ne peut pas être modifié, mais il peut être généré à nouveau sur la page Modifier. Générer un nouveau secret de client et enregistrer le compte rend immédiatement invalides tous les jetons OAuth associés à ce compte. Tout appel d'API utilisant ces jetons ne pourra pas accéder à l'API.

API :: Champs personnalisés

Créez des champs d'API personnalisés pour collecter des informations sur votre client, ce qui vous permet d'intégrer Bomgar de manière plus poussée avec vos programmes existants. Les champs personnalisés doivent être utilisés en combinaison avec l’API Bomgar. Pour plus d’informations, consultez le Guide de l’API.

Créer un nouveau champ, modifier, supprimer

Créer un nouveau champ, modifier ou supprimer un champ existant.

API :: Champs personnalisés :: Ajouter ou modifier

Nom affiché

Créez un nom unique pour identifier ce champ personnalisé. Ce nom est affiché dans la console d'accès dans les détails de session.

Nom de code

Définissez également un nom de code, qui sera utilisé à des fins d'intégration. Dans le cas contraire, le système en crée un automatiquement.

Afficher dans la console d'accès

Si vous cochez Afficher dans la console d'accès, ce champ et ses valeurs apparaîtront là où les détails de session personnalisés s'affichent dans la console d'accès.