Vous êtes déjà client NinjaOne ? Connectez-vous pour consulter d'autres guides et les dernières nouvelles.

Opérations de l’API publique NinjaOne

  • Dernière mise à jour 6 septembre 2026

Rubrique

Cet article explique où trouver et comment utiliser l'interface de programmation d'application (API) publique de NinjaOne.

Environnement

  • NinjaOne Documentation
  • API publique de NinjaOne

Description

Utilisez la page de l'API publique de NinjaOne pour consulter toutes les demandes disponibles dans NinjaOne et leurs fonctions, créer des exemples de demandes, ainsi que consulter ou copier les réponses.

Si vous avez des questions concernant la configuration ou la documentation de l'API, vous pouvez contacter l'équipe API de NinjaOne à l'adresse [email protected].

Sélectionnez un sujet pour en savoir plus :

Où trouver les ressources de l'API

Pour obtenir la liste complète de toutes les requêtes API, consultez la Documentation de l'API publique NinjaOne, accessible depuis le Menu des ressources d’aide situé dans le coin supérieur droit de NinjaOne. Le lien se trouve au bas du menu.

api documentation location.png
Figure 1: Accéder à la Documentation de l'API publique de NinjaOne (cliquez pour agrandir)

L'API publique de NinjaOne fournit des ressources complémentaires concernant la syntaxe du filtre d'appareils et les webhooks. Cliquez sur les liens fournis dans la documentation de l'API pour en savoir plus :

  • Syntaxe du filtre d'appareils: explique les exigences syntaxiques pour la chaîne codée par URL du paramètre de filtre d'appareils.
  • Webhooks: décrit comment configurer une intégration de lien web.
public API resources.png
Figure 2: Ressources de l’API publique de NinjaOne

Explorer l’API

NinjaOne met à disposition une API publique qui vous permet de consulter un index complet des modèles pour les entités de l’API. Les opérations disponibles incluent les méthodes de requête POST, GET, PATCH, DELETE et PUT.

Autorisation

L'API publique NinjaOne utilise OAuth 2.0 pour effectuer l'authentification des requêtes. OAuth 2.0 permet aux applications d'accéder aux ressources NinjaOne disponibles via l'API.

Cliquez sur « Autorisation » pour consulter la documentation décrivant les exigences d’autorisation de l’API publique NinjaOne.

public api 2.0_authorization.png
Figure 3: Vérifiez la documentation relative à l'autorisation de l'API publique NinjaOne 2.0

Reportez-vous à la NinjaOne Documentation : Autorisation de l’API publique 2.0 pour savoir comment configurer ces paramètres.

Schémas API

Vous trouverez les schémas de l'API à la fin de la liste des modèles d'API. Le schéma de l'API définit les paramètres obligatoires et les contraintes relatives aux données échangées lors des appels API, ce qui vous permet de limiter les erreurs lors de vos interactions avec l'API.

public API schemas.png
Figure 4: Schémas de l’API publique de NinjaOne

Modifications apportées à l'API

Nous améliorons actuellement la documentation de l’API afin d’en optimiser l’organisation et la visibilité. Pour consulter la nouvelle documentation de l’API, procédez comme suit.

  1. Cliquez sur « Détails » ici, à côté de la mention « Modifications à venir de l’API » en haut de la page, pour en savoir plus.
API_change details.png
Figure 5: Affichage des modifications à venir de l’API publique de NinjaOne
  1. Depuis la page de la version bêta de l'API publique de NinjaOne, cliquez sur « Ressources principales » pour découvrir la nouvelle mise en page. Cliquez sur « Retour au site précédent » pour consulter la documentation de l'API d'origine.
API_core resources_return to previous site.png
Figure 6: Consulter la nouvelle mise en page des ressources principales ou revenir au site précédent
  1. Reportez-vous à la section « Tester les points de terminaison de l’API publique 2.0 » pour savoir comment interagir avec la page.

Comment tester ou envoyer une requête API

Tester une méthode de requête

Lorsque vous êtes dans l’API publique, vous pouvez tester puis exécuter une méthode de requête en suivant les étapes suivantes :

  1. Développez une requête pour afficher les détails, puis cliquez sur « Essayer ». Certaines requêtes, comme celle illustrée à la figure 7, peuvent nécessiter la saisie d'un paramètre. Les paramètres peuvent être facultatifs et servent à organiser ou à limiter les données affichées dans une réponse. Pour savoir comment obtenir un ID de paramètre, consultez la section de cet article intitulée « Comment trouver les identifiants de requête ».
try the api.png
Figure 7: Essai des points de terminaison de l’API publique de NinjaOne
  1. Après avoir saisi les paramètres nécessaires, cliquez sur « Exécuter ». La réponse à la requête s’affichera dans la section « Réponses » de ce modèle.
api_execute query.png
Figure 8: Exécuter la requête API et afficher la réponse (cliquez pour agrandir)
  1. Une fois la réponse obtenue, vous pouvez copier l’URL de la requête ou cliquer sur « Télécharger » pour enregistrer la réponse sous forme de fichier JSON.

Vous pouvez utiliser les requêtes API personnalisables avec des plate-formes basées sur une interface graphique, telles que Postman, pour parcourir ou tester. Pour savoir comment utiliser Postman, consultez la documentation Postman | Postman Docs (lien externe). Pour obtenir de l’assistance sur l’application Postman, consultez le centre d’assistance Postman (lien externe).

Tester les points de terminaison de l’API publique 2.0

Dans la version bêta de l'API publique de NinjaOne, accédez aux requêtes depuis le menu latéral. Les requêtes fonctionnent de manière similaire à celles de la section précédente, mais vous devez vous assurer que l'autorisation est configurée avant de les utiliser. Reportez-vous à la NinjaOne Documentation : Autorisation de l'API publique 2.0 pour savoir comment configurer ces paramètres.

  1. Sélectionnez votre requête dans le menu latéral pour consulter les détails.
  2. Saisissez vos informations d’autorisation dans le champ « Jeton » ou « sessionKey », selon la méthode d’autorisation que vous préférez.
  3. Saisissez les paramètres, si nécessaire.
  4. Cliquez sur « Envoyer la demande API ».
  5. Consultez la Réponse.
api beta query and response.png
Figure 9: Exemple de réponse à une requête de l’API publique NinjaOne en version bêta (cliquez pour agrandir)

Comment trouver les identifiants de requête

Certaines requêtes API peuvent vous demander de saisir un identifiant, tel qu’un ID d’organisation ou d’appareil. Dans la plupart des cas, vous pouvez utiliser les entités et ressources du système de base pour trouver ces données. Les étapes suivantes fournissent un exemple permettant d’obtenir un ID d’organisation afin que vous puissiez renvoyer une liste d’emplacements via l’API publique NinjaOne.

  1. Développez la requête /v2/organizations et cliquez sur « Essayer ». Cliquez ensuite sur « Exécuter ».
  2. Copiez la valeur de « id ».
api_response_id.png
Figure 10: Copier l’ID de la réponse
  1. Accédez à la requête /v2/organization/{id}/locations.
  2. Cliquez sur « Try it out » (Essayer) et collez la valeur copiée dans le champ « id ».
api_query id.png
Figure 11: Saisir l’ID de la requête
  1. Cliquez sur « Exécuter » et consultez la réponse.

Ressources complémentaires

Consultez les ressources suivantes pour en savoir plus sur l’API NinjaOne.

FAQ

Pour aller plus loin