L'API d'Atera offre plusieurs méthodes d'intégration et d'extension des fonctionnalités d'Atera. Utilisez notre API pour facilement intégrer des éléments à votre système de comptabilité, améliorer la productivité de votre équipe et créer des intégrations plus fluides.
Votre compte est protégé par une clé d'accès API unique (API REST). Pour utiliser l'API d'Atera, vous devez vous connecter avec cette clé.
Remarque : à partir du 1er juin, nous ne prendrons en charge que les demandes d'API via HTTPS. Si vous ne l'avez pas encore fait, veuillez modifier toute implémentation HTTP de l'API que vous pourriez avoir en HTTPS pour des communications plus sûres. Si vous utilisez déjà HTTPS, vous n'avez rien à faire !
Cet article vous montre comment révéler votre clé API Atera et comment vous connecter avec votre clé API Atera
Pour vous aider au mieux, nous partagerons ici des exemples concernant deux requêtes, la requête GET ainsi que la requête PUT :
- Demander des informations sur l'agent
- Demander des informations sur le client
- Mettre à jour un client spécifique
Cliquez ici pour accéder à la page de documentation API d'Atera
Pour révéler votre clé API:
1. Depuis la section Admin du panneau latéral, cliquez sur API.
La page API apparaît.
3. Cliquez sur l'icône en forme d'œil pour révéler votre clé API.
Remarque: vous devrez fournir cette clé pour chaque requête faites à l'API Atera. Veuillez garder cette clé secrète en sécurité car elle expose vos contacts ainsi que leurs appareils. Si vous devez réinitialiser votre clé pour une raison quelconque, cliquez sur Réinitialiser ma clé API (la réinitialisation de la clé API entraînera l'échec de toute demande effectuée avec l'ancienne clé).
Pour vous connecter avec votre clé API:
1. Depuis la section Admin du panneau latéral, cliquez sur API.
La page API apparaît.
2. Cliquez sur Afficher la documentation. La page de documentation de l'API Atera s'ouvrira dans un nouvel onglet.
3. Cliquez sur Log in (Connexion), en haut à droite de la page. La fenêtre Available authorizations (Autorisations disponibles) s'affiche.
4. Entrez votre clé API. Cliquez ensuite sur Authorize (Autoriser).
L'API vous donne accès à de nombreux autres types de données, notamment:
| Agents | MachineID, AgentID, DeviceGUID, FolderID, CustomerID, CustomerName, etc. |
| Alerts (Alertes) | AlertID, Code, Source, Title, Severity, Created, SnoozedEndDate, etc. |
| Billing (Facturation) | InvoiceID, InvoiceNumber, InvoiceNumberAsString, Total, Subtotal, Tax, etc. |
| Contacts | EndUserID, CustomerID, CustomerName, JobTitle, Email, Phone, etc. |
| Contracts (Contrats) | CustomerID, ContractName, ContractType, Active, Taxable, StartDate, etc. |
| Customers (Clients) | CustomerID, CustomerName, CreatedOn, LastModified, Domain, Address, etc. |
| CustomValues (Valeurs personnalisées) | ItemID, ID, FieldName, ValueAsString, ValueAsDecimal, ValueAsBool, etc. |
| Device (Appareil) | Name, DeviceID, DeviceGuid, CustomerID, CustomerName, MntrngAgentID etc. |
| KnowledgeBase (Base de connaissances) | KBID, KBTimestamp, KBContext, KBProduct, KBLastModified, etc. |
| Rates (Taux) | RateID, Amount, Description, SKU, and Category. |
| Tickets (Inscriptions) | TicketID, TicketTitle, EndUserID, EndUserEmail, TicketResolvedDate, etc. |
Exemples
Pour obtenir la liste des agents sous forme de chaîne curl:
1. Allez sur https://app.atera.com/apidocs. La page API Atera apparaît. Si ce n'est pas déjà fait, connectez-vous
2. Cliquez sur Agent. La liste déroulante des méthodes de l' Agent s'ouvre.
3. Cliquez sur GET /api/v3/agents.
4. Cliquez sur Try It Out! Le Curl va se générer.
Le Response Body (Champs de réponse) affiche les informations sur l'agent et ce pour chaque agent.
Pour obtenir la liste des clients sous forme de chaîne curl:
1. Allez sur https://app.atera.com/apidocs. La page API Atera apparaît. Si ce n'est pas déjà fait, connectez-vous
2. Cliquez sur Customer pour choisir le client.
3. Cliquez sur GET /api/v3/customers.
4. Cliquez sur Try It Out! pour tester. Le Curl va se générer.
Le Response Body (champs de réponse) affiche une liste de tous les clients et leurs informations associées.
Pour mettre à jour un client:
Pour implémenter avec succès cet appel de méthode PUT , vous aurez besoin de l'ID client. Consultez notre exemple précédent ou jetez un œil à votre URL sur la page client spécifique.
1. Allez sur https://app.atera.com/apidocs. La page API Atera apparaît. Si ce n'est pas déjà fait, connectez-vous
2. Cliquez sur Customer pour choisir le client.
3. Cliquez sur PUT /api/v3/customers/{customerID}.
4. Entrez le customerID (l'ID client).
5. Cliquez n'importe où dans la zone sur le côté droit de la page pour remplir le champ client.
6. Apportez les modifications souhaitées.
7. Cliquez sur Try it out! pour tester. Le Curl va se générer.
Le client est mis à jour. Le Response Body (Champs de réponse) montre quel client a été mis à jour et le Response Code (Code de réponse) indique qu'il a réussi.
