API, acronimo di Application Programming Interface, si riferisce a un meccanismo attraverso il quale diversi componenti software interagiscono. In questo contesto, "applicazione" comprende qualsiasi software con funzionalità specifiche, mentre "interfaccia" può essere intesa come un accordo di servizio tra due applicazioni. Questo accordo delinea i protocolli per la loro comunicazione, con richieste e risposte.
Nota importante: si ricorda che il supporto di Atera non offre assistenza per la creazione o la risoluzione dei problemi delle connessioni API.
Domande frequenti
In questa sezione vengono trattate le domande più frequenti riguardanti l'API di Atera.
D: Che cos'è un'API?
R: Un'interfaccia di programmazione delle applicazioni, spesso indicata come API, serve a far sì che più programmi informatici possano scambiare informazioni e interagire. In sostanza, funziona come un'interfaccia software che fornisce un servizio ad altri componenti software.
D: Atera dispone di un'API?
R: Sì, Atera fornisce un'API che consente di integrare vari componenti di Atera con altre applicazioni software.
D: Qual è il costo dell'integrazione API?
R: Il modulo API di Atera è incluso nell'abbonamento senza costi aggiuntivi. Tuttavia, è importante notare che durante il periodo di prova l'accesso alle API non è disponibile.
D: Cosa si può ottenere utilizzando l'API fornita da Atera?
R: Con l'API di Atera, è possibile integrare perfettamente Atera con varie applicazioni, come WhatsApp, Slack e Teams. Questa integrazione offre opportunità di applicazioni pratiche, come l'automatizzazione della creazione di ticket in Atera direttamente da queste piattaforme e la ricezione di notifiche di avviso o ticket in WhatsApp, Slack e Teams quando si verificano eventi in Atera. Inoltre, l'API consente di estrarre informazioni sugli agenti, sui ticket e sugli avvisi per creare un cruscotto personalizzato, adatto alla visualizzazione su un televisore in ufficio. L'API offre anche la possibilità di creare un modulo web sul vostro sito web, consentendo ai clienti di generare direttamente i ticket in Atera. La gamma di possibilità offerte dall'API di Atera è ampia e adattabile.
D: È possibile integrare qualsiasi applicazione software tramite l'API?
R: No, per l'integrazione con Atera è necessario che anche l'altra applicazione software disponga di una propria API.
D: Sono necessarie le conoscenze degli sviluppatori per integrare Atera con altre applicazioni software tramite l'API?
R: Sì, per ottenere un'integrazione API di successo, è essenziale una conoscenza di base dei linguaggi di programmazione come JavaScript o Python. Inoltre, è necessaria una solida conoscenza dei principi di progettazione HTTP/HTTPS e RESTful.
D: Quale strumento e quale versione di API utilizza Atera?
R: Atera utilizza Swagger V3 per gestire le sue API.
D: Quali sono gli scopi dei diversi tipi di richiesta, come GET, POST, DELETE e PUT?
R: Ogni tipo di richiesta ha una funzione distinta:
-
GET viene utilizzato per recuperare informazioni dai componenti disponibili nell'API. Ad esempio, è possibile utilizzare GET per estrarre informazioni sugli agenti e generare report sui propri agenti.
-
POST viene utilizzato per inserire dati nell'istanza di Atera. Ad esempio, l'opzione POST nella sezione ticket viene utilizzata per creare nuovi ticket all'interno di Atera.
-
PUT ha uno scopo simile a quello di POST, in quanto viene utilizzato per aggiungere dati all'istanza di Atera. Tuttavia, la differenza fondamentale è che PUT viene utilizzato per aggiornare le voci esistenti, mentre POST viene utilizzato per crearne di nuove.
-
DELETE, come suggerisce il nome, è utilizzato per rimuovere una voce specifica all'interno dell'istanza Atera.
D: A quali dati si può accedere o aggiungere ad Atera tramite l'API?
R: L'API offre diverse funzionalità tra i vari componenti di Atera:
-
Agenti: L'API consente di ottenere o cancellare i dati relativi agli agenti Windows, Mac e Linux.
-
Avvisi: Utilizzando l'API, è possibile eseguire operazioni GET, POST e DELETE sulle informazioni degli avvisi all'interno della propria istanza Atera.
-
Fatturazione: È possibile utilizzare l'API per ottenere informazioni sulle fatture all'interno di Atera.
-
Contatti: L'API fornisce opzioni per operazioni GET, POST, PUT e DELETE sui contatti all'interno dell'ambiente Atera.
-
Contratti: È possibile ottenere informazioni sui contratti utilizzando l'API.
-
Clienti: Per le informazioni sui clienti, l'utente dispone di un controllo completo tramite l'API, che include le operazioni GET, POST, PUT e DELETE.
-
Valori personalizzati: Con questa funzionalità, è possibile ottenere o inserire i dati relativi ai campi personalizzati all'interno dell'istanza Atera.
-
Dispositivo: È possibile GET, POST o PUT dei dispositivi di monitoraggio, compresi i dispositivi SNMP, TCP, HTTP e generici. L'opzione POST consente di creare dispositivi di monitoraggio direttamente dall'API, facilitando l'importazione da altre applicazioni software.
-
Base di conoscenze: L'API consente di ottenere informazioni dai vostri articoli di conoscenza, permettendovi di avere una copia della vostra base di conoscenza su un sito web interno.
-
Tariffe: È possibile gestire le tariffe dei contratti tramite l'API, con opzioni GET, POST, PUT o DELETE.
-
Biglietti: Per le operazioni relative ai biglietti sono disponibili tutti i tipi di richiesta: GET, POST, PUT o DELETE. Questa sezione può essere utilizzata per recuperare informazioni sui biglietti, creare nuovi biglietti, aggiornare quelli esistenti o eliminarli.
D: Posso definire richieste o azioni API personalizzate per lavorare con i dati oltre a quelle menzionate in precedenza?
R: No, la personalizzazione dell'API non è supportata. Le chiamate e le richieste API disponibili sono limitate a quelle elencate nella domanda precedente.
D: Esistono articoli che dimostrano come utilizzare l'API?
R: Sì, per informazioni dettagliate sull'utilizzo dell'API di Atera, consultare il seguente articolo.
D: C'è una limitazione al volume di dati che posso gestire attraverso l'API di Atera?
R: Sì, esiste un limite al numero di richieste al minuto in base all'abbonamento. Per l'abbonamento di livello più basso, il limite è fissato a 400 richieste al minuto, mentre l'abbonamento di livello più alto consente un numero maggiore di richieste al minuto. È fondamentale considerare anche eventuali limitazioni API inerenti all'applicazione software che si intende integrare con l'API di Atera.