Sei già un cliente NinjaOne? Effettua il login per visualizzare le altre guide e gli ultimi aggiornamenti.

Operazioni API pubbliche di NinjaOne

Argomento

Questo articolo spiega dove trovare e come utilizzare l'API (Application Programming Interface) pubblica di NinjaOne.

Ambiente

  • Documentazione NinjaOne
  • API pubblica di NinjaOne

Descrizione

Utilizza la pagina dell'API pubblica di NinjaOne per visualizzare tutte le richieste disponibili in NinjaOne e le relative funzioni, creare query di esempio e visualizzare o copiare le risposte.

Per qualsiasi domanda sulla configurazione o sulla documentazione dell'API, è possibile contattare il team API di NinjaOne all'indirizzo [email protected].

Seleziona un argomento per saperne di più:

Dove trovare le risorse API

Per un elenco completo di tutte le query API, consultare la documentazione dell'API pubblica di NinjaOne, accessibile dal menu Risorse della guida nell'angolo in alto a destra di NinjaOne. Il link si trova nella parte inferiore del menu.

Figura 1: Accedere alla documentazione dell'API pubblica di NinjaOne (cliccare per ingrandire)

L'API pubblica di NinjaOne fornisce risorse aggiuntive per la sintassi del filtro dei dispositivi e i webhook. Clicca sui link forniti nella documentazione API per saperne di più:

  • Sintassi del filtro dei dispositivi: spiega i requisiti di sintassi per la stringa codificata in URL del parametro del filtro dei dispositivi.
  • Webhook: descrive come configurare un'integrazione webhook.
public API resources.png
Figura 2: Risorse dell'API pubblica di NinjaOne

Esplora l'API

NinjaOne fornisce un'API pubblica che consente di visualizzare un indice completo dei modelli per le entità API. Le operazioni disponibili includono i metodi di richiesta POST, GET, PATCH, DELETE e PUT.

Autorizzazione

L'API pubblica di NinjaOne utilizza OAuth 2.0 per autenticare le richieste. OAuth 2.0 consente alle applicazioni di ottenere l'accesso alle risorse NinjaOne rese disponibili tramite l'API.

Fai clic su Autorizzazione per consultare la documentazione che descrive i requisiti di autorizzazione nell'API pubblica di NinjaOne.

public api 2.0_authorization.png
Figura 3: Consulta la documentazione sull'autorizzazione dell'API pubblica NinjaOne 2.0

Fare riferimento alla

Figura 4: Schemi dell'API pubblica di NinjaOne

Modifiche all'API

Stiamo migliorando la documentazione API per una migliore organizzazione e visibilità. Per visualizzare la nuova documentazione API, segui questi passaggi.

  1. Fare clic su Dettagli qui, dove è indicato " Modifiche imminenti all'API " nella parte superiore della pagina, per ulteriori informazioni.
API_change details.png
Figura 5: Visualizza le modifiche imminenti all'API pubblica di NinjaOne
  1. Dalla pagina beta dell'API pubblica di NinjaOne, fare clic su " Risorse principali " per visualizzare il nuovo layout. Fare clic su "Torna al sito precedente " per visualizzare la documentazione API originale.
API_core resources_return to previous site.png
Figura 6: Visualizza il nuovo layout delle risorse principali o torna al sito precedente
  1. Fare riferimento alla sezione "Testare gli endpoint dall'API pubblica 2.0" per imparare a interagire con la pagina.

Come testare o inviare la richiesta API

Testare un metodo di richiesta

Mentre si è nell'API pubblica, è possibile testare e quindi eseguire un metodo di richiesta seguendo questi passaggi:

  1. Espandi una query per visualizzarne i dettagli e fai clic su Provalo. Alcune query, come quella mostrata nella Figura 7, potrebbero richiedere l'inserimento di un parametro. I parametri possono essere facoltativi per organizzare o limitare i dati mostrati in una risposta. Per scoprire come ottenere un ID parametro, consulta la sezione di questo articolo intitolata Come trovare gli identificatori di query.
try the api.png
Figura 7: Prova degli endpoint dell'API pubblica di NinjaOne
  1. Dopo aver inserito i parametri necessari, fare clic su Esegui. La risposta alla query apparirà nella sezione Risposte di quel modello.
Figura 8: Esegui la query API e visualizza la risposta (clicca per ingrandire)
  1. Una volta completata la risposta, è possibile copiare l'URL della richiesta o fare clic su Scarica per salvare la risposta come file JSON.

È possibile utilizzare le richieste API personalizzabili con piattaforme basate su GUI, come Postman, per la navigazione o il test. Per informazioni su come utilizzare Postman, consultare Postman Docs | Postman Docs (link esterno). Per l'assistenza sull'applicazione Postman, consultare il centro assistenza Postman (link esterno).

Testare gli endpoint dall'API pubblica 2.0

All'interno della versione beta dell'API pubblica NinjaOne, accedere alle query dal menu della barra laterale. Le richieste funzioneranno in modo simile alla sezione precedente, ma è necessario assicurarsi di aver configurato l'autorizzazione prima di utilizzarle. Fare riferimento alla Documentazione NinjaOne: Autorizzazione API pubblica 2.0 per imparare a configurare queste impostazioni.

  1. Seleziona la query dal menu laterale per visualizzarne i dettagli.
  2. Inserisci l'autorizzazione nel campo Token o sessionKey, a seconda del metodo di autorizzazione preferito.
  3. Inserisci i parametri, se necessario.
  4. Fare clic su Invia richiesta API.
  5. Visualizza la risposta.
Figura 9: Esempio di risposta a una query dell'API pubblica beta di NinjaOne (clicca per ingrandire)

Come trovare gli identificatori di query

Alcune query API potrebbero richiedere l'inserimento di un identificatore, come l'ID di un'organizzazione o di un dispositivo. Nella maggior parte dei casi, è possibile utilizzare le entità e le risorse di sistema principali per trovare questi dati. I passaggi seguenti forniscono un esempio per ottenere un ID organizzazione in modo da poter restituire un elenco di sedi all'interno dell'API pubblica NinjaOne.

  1. Espandi la query /v2/organizations e clicca su Provalo. Quindi, clicca su Esegui.
  2. Copia il valore di "id".
api_response_id.png
Figura 10: Copia l'ID della risposta
  1. Passare alla query /v2/organization/{id}/locations.
  2. Fare clic su Provalo e incollare il valore copiato nel campo id.
api_query id.png
Figura 11: Inserisci l'ID della query
  1. Fare clic su Esegui e visualizzare la risposta.

Risorse aggiuntive

Consulta le seguenti risorse per ulteriori informazioni sull'API NinjaOne.

Domande frequenti

Passi successivi