Opérations de l’API publique NinjaOne

Sujet

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

Environnement

• Documentation NinjaOne
• API publique de NinjaOne

Description

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

Sélectionnez un sujet pour en savoir plus :

• Où trouver les ressources de l'API
• Explorer l'API
  • Autorisation
  • Schémas de l'API
  • Modifications de l'API
• Comment tester ou envoyer une requête API
  • Tester une méthode de requête
  • Tester les points de terminaison de l'API publique 2.0
  • Comment trouver les identifiants de requête
• Ressources supplémentaires

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.

L'API publique de NinjaOne fournit des ressources supplémentaires sur la syntaxe du filtre de périphériques et les webhooks. Cliquez sur les liens fournis dans la documentation de l'API pour en savoir plus :

• Syntaxe du filtre de périphériques: explique les exigences syntaxiques pour la chaîne encodée en URL du paramètre de filtre de périphériques.
• Webhooks: décrit comment configurer une intégration de webhook.

Explorer l'API

NinjaOne fournit 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 authentifier les requêtes. OAuth 2.0 permet aux applications d'accéder aux ressources NinjaOne mises à disposition via l'API.

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

Consultez

Modifications de l'API

Nous améliorons la documentation de l'API pour une meilleure organisation et une meilleure visibilité. Pour consulter la nouvelle documentation de l'API, procédez comme suit.

1. Cliquez sur « Détails » ici, à l'endroit où il est indiqué « Modifications à venir de l'API » en haut de la page, pour en savoir plus.

2. Sur la page bêta de l'API publique de NinjaOne, cliquez sur « Ressources principales » pour afficher la nouvelle mise en page. Cliquez sur « Retour au site précédent » pour consulter la documentation d'API d'origine.

3. 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 « Try it out » (Essayer). Certaines requêtes, comme celle de la figure 7, peuvent vous demander de saisir un paramètre. Les paramètres peuvent être facultatifs pour organiser ou limiter les données affichées dans une réponse. Pour savoir comment obtenir un identifiant de paramètre, consultez la section de cet article intitulée « Comment trouver les identifiants de requête ».

2. 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.

3. 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 plateformes basées sur une interface graphique, telles que Postman, pour la navigation ou les tests. Pour savoir comment utiliser Postman, consultez la documentation Postman | Postman Docs (lien externe). Pour obtenir de l'aide 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 NinjaOne, accédez aux requêtes depuis le menu de la barre latérale. Les requêtes fonctionnent de manière similaire à la section précédente, mais vous devez vous assurer que l'autorisation est configurée avant de les utiliser. Consultez la documentation NinjaOne : Autorisation de l'API publique 2.0 pour savoir comment configurer ces paramètres.

1. Sélectionnez votre requête dans le menu de la barre latérale pour afficher les détails.
2. Saisissez votre autorisation dans le champ Token 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 requête API.
5. Affichez la réponse.

Comment trouver les identifiants de requête

Certaines requêtes API peuvent vous demander de saisir un identifiant, tel qu'un identifiant 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 identifiant d'organisation afin que vous puissiez renvoyer une liste d'emplacements au sein de l'API publique NinjaOne.

1. Développez la requête /v2/organizations et cliquez sur « Try it out ». Cliquez ensuite sur « Execute ».
2. Copiez la valeur de « id ».

3. Accédez à la requête /v2/organization/{id}/locations.
4. Cliquez sur « Try it out » et collez la valeur copiée dans le champ « id ».

5. Cliquez sur Exécuter et consultez la réponse.

Ressources supplémentaires

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

• Filtrer les tickets NinjaOne avec l'API publique
• Configuration du jeton OAuth de l'API
• Gérer vos utilisateurs avec l'API publique de NinjaOne
• Documentation NinjaOne : Catalogue de ressources
• Gestion des points de terminaison NinjaOne : catalogues de ressources pour les scripts, l'automatisation et l'interface CLI