L'API, acronyme de Application Programming Interface (interface de programmation d'applications), désigne un mécanisme par lequel différents composants logiciels interagissent. Dans ce contexte, le terme "application" englobe tout logiciel doté d'une fonctionnalité spécifique, tandis que le terme "interface" peut être compris comme un accord de service entre deux applications. Cet accord décrit les protocoles de communication entre les deux applications, y compris les demandes et les réponses.
Remarque importante : veuillez noter que le service d'assistance d'Atera n'offre pas d'aide pour la création ou le dépannage des connexions API.
Questions fréquemment posées
Cette section aborde les questions fréquemment posées concernant l'API d'Atera.
Q : Qu'est-ce qu'une API ?
R : Une interface de programmation d'application, souvent appelée API, permet à plusieurs programmes informatiques d'échanger des informations et d'interagir. Il s'agit essentiellement d'une interface logicielle qui fournit un service à d'autres composants logiciels.
Q : L'intégration d'Atera à d'autres applications logicielles par l'intermédiaire de l'API nécessite-t-elle des connaissances de développeur ?
R : Oui, pour réussir l'intégration de l'API, il est essentiel d'avoir une connaissance de base des langages de programmation tels que JavaScript ou Python. En outre, il est nécessaire de bien maîtriser les principes de conception HTTP/HTTPS et RESTful.
Q : Quels sont l'outil et la version de l'API utilisés par Atera ?
R : Atera utilise Swagger V3 pour gérer son API.
Q : À quoi servent les différents types de demandes, tels que GET, POST, DELETE et PUT ?
R : Chaque type de demande remplit une fonction distincte :
- GET est utilisé pour récupérer des informations à partir des composants disponibles dans l'API. Par exemple, vous pouvez utiliser GET pour extraire des informations sur les agents et générer des rapports sur vos agents.
- POST est utilisé pour introduire des données dans votre instance Atera. Par exemple, l'option POST de la section des tickets est utilisée pour créer de nouveaux tickets au sein d'Atera.
- PUT a une fonction similaire à POST, puisqu'il est également utilisé pour ajouter des données à votre instance Atera. Cependant, la principale différence est que PUT est utilisé pour mettre à jour les entrées existantes, alors que POST est utilisé pour en créer de nouvelles.
- DELETE, comme son nom l'indique, est utilisé pour supprimer une entrée spécifique dans votre instance Atera.
Q : Quelles sont les données auxquelles on peut accéder ou que l'on peut ajouter à Atera par le biais de l'API ?
R : L'API offre diverses fonctionnalités dans les différents composants d'Atera :
- Agents : L'API vous permet d'obtenir ou de supprimer des données relatives à vos agents Windows, Mac et Linux.
- Alertes : L'API vous permet d'effectuer des opérations GET, POST et DELETE sur les informations relatives aux alertes au sein de votre instance Atera.
- Facturation : Vous pouvez utiliser l'API pour obtenir des informations sur vos factures au sein d'Atera.
- Contacts : L'API offre des options pour les opérations GET, POST, PUT et DELETE sur les contacts au sein de votre environnement Atera.
- Contrats : Vous pouvez obtenir des informations sur vos contrats à l'aide de l'API.
- Clients : Pour les informations sur les clients, vous disposez d'un contrôle complet via l'API, y compris les opérations GET, POST, PUT et DELETE.
- Valeurs personnalisées : Cette fonctionnalité vous permet d'obtenir ou d'envoyer des données concernant vos champs personnalisés au sein de votre instance Atera.
- Appareil : Vous pouvez obtenir, envoyer ou transférer des dispositifs de surveillance, y compris des dispositifs SNMP, TCP, HTTP et génériques. L'option POST vous permet de créer des dispositifs de surveillance directement à partir de l'API, ce qui facilite les importations à partir d'autres applications logicielles.
- Base de connaissances : L'API vous permet d'obtenir des informations à partir de vos articles de connaissance, ce qui vous permet d'avoir une copie de votre base de connaissances sur un site web interne.
- Tarifs : Vous pouvez gérer les tarifs de vos contrats à l'aide de l'API, avec des options GET, POST, PUT ou DELETE.
- Tickets : Tous les types de demandes sont disponibles pour les opérations liées aux tickets : GET, POST, PUT ou DELETE. Cette section peut être utilisée pour récupérer des informations sur les tickets, créer de nouveaux tickets, mettre à jour des tickets existants ou les supprimer.
Q : Puis-je définir mes propres requêtes ou actions API pour travailler avec des données autres que celles mentionnées plus haut ?
R : Non, la personnalisation de l'API n'est pas prise en charge. Les appels et requêtes API disponibles sont limités à ceux énumérés dans la question précédente.
Q : Existe-t-il des articles qui expliquent comment utiliser l'API ?
R : Oui, pour obtenir des informations détaillées sur l'utilisation de l'API d'Atera, veuillez consulter l'article suivant.
Q : Existe-t-il une limite au volume de données que je peux gérer par l'intermédiaire de l'API d'Atera ?
R : Oui, le nombre de requêtes par minute est limité en fonction de votre abonnement. Pour l'abonnement de niveau inférieur, la limite est fixée à 400 requêtes par minute, tandis que l'abonnement de niveau supérieur permet un plus grand nombre de requêtes par minute. Il est essentiel de prendre en compte les limitations d'API inhérentes à l'application logicielle que vous souhaitez intégrer à l'API d'Atera.