Uptrends API version 4 est un ensemble croissant d'appels d'API qui vous permet de modifier votre configuration de la surveillance. Il vous permet d'effectuer ces tâches :

Enregistrer une API

Enregistrez un nouveau compte API pour accéder aux autres méthodes de cette API. Veuillez consulter la section Authentification ci-dessous.

Surveiller une API

Un ensemble de méthodes API pour gérer les définitions de moniteur :

  • modifier un moniteur de transactions existant,
  • modifier un moniteur API multi-étapes existant,
  • cloner un moniteur existant,
  • supprimer un moniteur existant.
  • modifier la période de maintenance d’un moniteur. Pour plus d’informations sur les modifications des périodes de maintenance via l’API, veuillez-vous référer à cette documentation.

    MonitorCheck API

    Un ensemble de méthodes d'API permettant d'accéder aux données brutes du moniteur lors de chaque contrôle individuel. Pour plus d'informations, consultez la documentation de l'API MonitorCheck.

    MonitorGroup API

    L'API du groupe de moniteurs contient des méthodes permettant d'ajouter, de mettre à jour et de supprimer des groupes de moniteurs, ainsi que des opérations supplémentaires sur les moniteurs contenus dans ces groupes, telles que le démarrage et l'arrêt de tous les moniteurs. Pour plus d'informations, veuillez consulter la documentation de l'API MonitorGroup.

    API Coffre-fort

    L'API du coffre-fort contient des méthodes permettant d'ajouter, de mettre à jour et de supprimer des éléments de votre coffre-fort, ainsi que de gérer les sections et les autorisations correspondantes. Pour plus d'informations, consultez la documentation de l'API Coffre-fort et l'article sur le coffre-fort dans la base de connaissances.

    API Points de Contrôle

    L'API Points de Contrôle vous permet de récupérer des informations sur les emplacements et les serveurs des points de contrôle qui effectuent la surveillance réelle. Les informations serveur de point de contrôle incluent les adresses IPv4 et IPv6 que vous pouvez ajouter à une liste blanche dans votre pare-feu. Pour plus d'informations, consultez la documentation Swagger relative aux points de contrôle.

    Autres API

    Pour les autres opérations, utilisez plutôt l'API version 3. En savoir plus sur choisir entre API v3 et API v4.

    Accéder à l'API v4 à l'aide de Swagger

    Vous pouvez découvrir toutes les méthodes d'API sur notre page OpenAPI (Swagger) : https://api.uptrends.com/v4/swagger. Cette page décrit toutes les méthodes de l'API en détail et vous permet d'exécuter chaque méthode individuellement.

    De plus, vous pouvez utiliser notre spécification Swagger avec Swagger Codegen pour générer du code client qui vous aidera à intégrer l'API Uptrends dans vos propres scripts ou applications. Pour plus d'informations sur Swagger et les outils Swagger, visitez Swagger.io.

    Authentification

    Puisque l'utilisation de chaque méthode API nécessite au préalable une authentification à l'aide d'un compte API, vous devez donc en créer un. La méthode Registre vous permet de créer un nouveau compte API. Dans cet exemple, nous allons utiliser l'environnement Swagger pour accéder directement à l'API et appeler la méthode Register. Le compte API que nous allons créer n'expirera pas, vous n'aurez donc besoin de le faire qu'une seule fois.

    1. Aller à la page Swagger, recherchez la méthode Register POST et développez-la.
    2. Cliquez sur le bouton "Essayez-le" pour démarrer la demande.
    3. Dans le champ de description, mettez quelque chose de simple, par exemple "Mon compte API". Laissez le champ de type vide.
    4. Cliquez sur le bouton Exécuter.
    5. Votre navigateur vous demandera maintenant de renseigner vos identifiants de connexion en tant qu'opérateur Uptrends, c'est-à-dire l'adresse e-mail et le mot de passe que vous utilisez normalement pour accéder à Uptrends.
    6. Une fois la connexion réussie, notez que le corps de la réponse contient des valeurs pour UserName et Password : ce sont les informations d'identification de votre nouveau compte API.
    7. Pensez à sauvegarder ces informations et les utiliser pour vous authentifier lors des autres appels d'API.
    8. Enfin, n'oubliez pas que ce compte API est lié à votre compte opérateur, donc il fonctionnera en utilisant vos privilèges.