L'API di Atera offre diversi metodi per integrare ed estendere le funzionalità di Atera. Utilizzate le nostre API per integrarvi facilmente con il vostro sistema contabile, migliorare la produttività del vostro team e creare integrazioni senza soluzione di continuità.
Il vostro account è protetto da una chiave di accesso API unica (API REST). È necessario accedere con questa chiave per utilizzare l'API di Atera.
Nota: Atera supporta le richieste API solo su HTTPS.
Rivela la tua chiave Atera API
Per rivelare la propria chiave API:
1. Da Admin, nel pannello laterale, fare clic su API.
Viene visualizzata la pagina API.
3. Fare clic sull'icona dell'occhio per visualizzare la chiave API.
Nota: sarà necessario fornire questa chiave ad ogni richiesta effettuata ad Atera API. Si prega di mantenere questa chiave segreta e sicura in quanto espone i contatti e i loro dispositivi. Se è necessario reimpostare la chiave per qualsiasi motivo, fare clic su Reimposta la mia chiave API (la reimpostazione della chiave API causerà il fallimento di qualsiasi richiesta effettuata con la vecchia chiave).
Eseguire il login con la chiave API di Atera
Per accedere con la propria chiave API:
1. Da Admin, nel pannello laterale, fare clic su API.
Viene visualizzata la pagina API.
2. Fare clic su Visualizza documentazione. La pagina della documentazione di Atera API si aprirà in una nuova scheda.
.
3. Fare clic su Accedi, in alto a destra della pagina. Viene visualizzata la finestra Autorizzazioni disponibili.
4. Immettere la chiave API. Quindi fare clic su Autorizza.
L'API consente di accedere a molti tipi di dati, tra cui:
| Agenti | MachineID, AgentID, DeviceGUID, FolderID, CustomerID, CustomerName, ecc. |
| Avvisi | AlertID, Codice, Sorgente, Titolo, Gravità, Creato, SnoozedEndDate, ecc. |
| Fatturazione | InvoiceID, InvoiceNumber, InvoiceNumberAsString, Total, Subtotal, tasse, ecc. |
| Contatti | EndUserID, CustomerID, CustomerName, JobTitle, Email, Phone, ecc. |
| Contratti | CustomerID, ContractName, ContractType, Active, Taxable, StartDate, ecc. |
| Clienti | CustomerID, CustomerName, CreatedOn, LastModified, Domain, Address, ecc. |
| Valori personalizzati | ItemID, ID, FieldName, ValueAsString, ValueAsDecimal, ValueAsBool, ecc. |
| Dispositivo | Nome, DeviceID, DeviceGuid, CustomerID, CustomerName, MntrngAgentID ecc. |
| ConoscenzaBase | KBID, KBTimestamp, KBContext, KBProduct, KBLastModified, ecc. |
| Tariffe | RateID, Amount, Description, SKU, and Category. |
| Biglietti | TicketID, TicketTitle, EndUserID, EndUserEmail, TicketResolvedDate, ecc. |
Esempi
- Richiedere informazioni sugli agenti.
- Richiesta informazioni sui clienti
- Aggiornamento di un cliente specifico
Per ottenere l'elenco degli agenti come stringa curl:
1. Andare a https://app.atera.com/apidocs. Viene caricata la pagina API di Atera. Se non l'avete già fatto, log in
2. Fare clic su Agente. Il menu a tendina Metodi dell'agente.
.
3. Fare clic su GET /api/v3/agents.
4. Fare clic su Prova! Il ricciolo verrà generato.
Il corpo della risposta visualizza le informazioni sull'agente per ciascun agente.
Per ottenere l'elenco dei clienti come stringa curl:
1. Andare a https://app.atera.com/apidocs. Viene caricata la pagina API di Atera. Se non l'avete già fatto, log in
2. Fare clic su Cliente.
3. Fare clic su GET /api/v3/clienti.
4. Fare clic su Prova! Curl genererà.
Il corpo della risposta visualizza un elenco di tutti i clienti e delle relative informazioni.
Per aggiornare un cliente:
Nota: per implementare con successo questa chiamata al metodo PUT, è necessario l'ID del cliente. Consultare il nostro esempio precedente o dare un'occhiata al proprio URL quando si è nella pagina specifica del cliente.
1. Andare a https://app.atera.com/apidocs. Viene caricata la pagina API di Atera. Se non l'avete già fatto, log in
2. Fare clic su Cliente.
.
3. Fare clic su PUT /api/v3/customers/{customerID}.
4. Immettere l'ID cliente.
5. Fare clic su un punto qualsiasi del riquadro sul lato destro della pagina per riempire il campo del cliente.
6. Apportare le modifiche desiderate.
7. Fare clic su Prova! Curl verrà generato.
Il cliente viene aggiornato. Il corpo della risposta indica quale cliente è stato aggiornato e il codice della risposta indica che l'aggiornamento ha avuto successo.
