Les exemples ci-dessous décrivent plusieurs demandes courantes, y compris l’authentification, la création d’appareils et de tâches, l’obtention d’une liste de plates-formes et l’obtention d’informations sur l’appareil à l’aide de Postman (voir aussi comment utiliser Postman pour les tests de charge).

Pour commencer avec l’API Dotcom-Monitor, l’en-tête HTTP/HTTPS doit avoir un ensemble de type contenu sur application/json.

Pour les détails de la méthode API, voir l’article correspondant de la catégorie Méthodes.

connectez-vous

Pour l’authentification, utilisez POST URI” /login«. Lorsque vous vous connectez vial’appel « /login», une nouvelle session client commence. Les sessions expirent automatiquement après une durée d’inactivité prédéterminée. La valeur par défaut est d’une minute. Si vous faites un appel API, la mise à zéro de la mise à zéro de la mise à zéro de la mise à zéro de la mise à l’heure de la période d’inactivité.

Lorsque votre session expire, le code d’erreur HTTP d’exception”401 – Non autorisé», est retourné. Si cela se produit, vous devez vous connecter à nouveau.

Il est recommandé d’utiliser votre UID d’intégration pour vous connecter(Intégration > de compte > UID).

POST /config_api_v1/login HTTP/1.1
Host: api.dotcom-monitor.com
Content-Type: application/json

{ 
"UID":"0E206D45650A4ACD8EB689B8CC25FA7F"
}

Obtenir des plates-formes

Pour obtenir la liste des plateformes de surveillance, utilisez GET URI “/platforms

«. Si la demande réussit, le serveur répond avec un code d’état HTTP et la liste de toutes les plateformes disponibles. Il est recommandé d’enregistrer la réponse afin d’utiliser les détails de votre compte (identifiant de paquet, identifiant des plates-formes, identifiant de périphérique, etc.) dans les demandes ultérieures.

GET /config_api_v1/platforms HTTP/1.1
Host: api.dotcom-monitor.com
Content-Type: application/json

Créer un appareil

Utilisez les données reçues dans la réponse «Plateformes GET» pour créer une demande JSON. Les paramètres de l’appareil qui ne sont pas spécifiés dans la demande seront définis par défaut.

POST /config_api_v1/devices?verb=PUT HTTP/1.1
Host: api.dotcom-monitor.com
Content-Type: application/json

{ 
"Postpone":"true",
"Frequency":60,
"Package_Id":465,
"Platform_Id":12,
"Locations":{2,4,6,18,68},
"Name":"TESTDEVICE 9.23.2019"
}

Créer une tâche

Post /config_api_v1/tasks?verb=PUT HTTP/1.1
Host: api.dotcom-monitor.com
Content-Type: application/json

{
"Name":"testname",
"Url":"https://dotcom-monitor.com",
"Device_Id":123456,
"RequestType":"GET",
"Task_Type_Id":2,
"DNSResolveMode":"Device Cached"
}

Obtenir et modifier les informations de l’appareil

Pour modifier les informations de l’appareil, envoyez d’abord une demande GET avec l’iD de l’appareil dans URI pour recevoir la réponse du serveur.

GET /config_api_v1//device/193403 HTTP/1.1
Host: api.dotcom-monitor.com
Content-Type: application/json

Ensuite, utilisez le corps de réponse pour modifier les paramètres de l’appareil et renvoyer la demande JSON avec de nouvelles valeurs.

POST /config_api_v1//device/193403 HTTP/1.1
Host: api.dotcom-monitor.com
Content-Type: application/json

{
    "Avoid_Simultaneous_Checks": false,
    "Alert_Silence_Min": 0,
    "False_Positive_Check": false,
    "Locations": [
        1,
        2,
        3,
        4,
        6,
        11,
        13,
        14,
        15,
        18,
        19,
        23,
        43,
        68,
        97,
        113,
        118,
        138,
        153,
        233
    ],
    "Send_Uptime_Alert": false,
    "Status_Description": "POSTPONED",
    "Postpone": true,
    "Owner_Device_Id": 0,
    "Frequency": 10800,
    "Filter_Id": 7791,
    "Scheduler_Id": 0,
    "Notifications": {
        "E_Mail_Flag": false,
        "E_Mail_Address": null,
        "E_Mail_TimeInterval_Min": 5,
        "WL_Device_Flag": false,
        "WL_Device_Email_Address": null,
        "WL_Device_TimeInterval_Min": 15,
        "Pager_Flag": false,
        "Pager_Area_Code": null,
        "Pager_Phone": null,
        "Pager_Num_Code": null,
        "Pager_TimeInterval_Min": 15,
        "Phone_Flag": false,
        "Phone_Area_Code": null,
        "Phone_Phone": null,
        "Phone_TimeInterval_Min": 15,
        "SMS_Flag": false,
        "SMS_Phone": null,
        "SMS_TimeInterval_Min": 15,
        "Script_Flag": false,
        "Script_Batch_File_Name": null,
        "Script_TimeInterval_Min": 0,
        "SNMP_TimeInterval_Min": 0,
        "Notification_Groups": []
    },
    "Id": 193403,
    "Number_Of_Tasks": 1,
    "WaitingForApproval": false,
    "Platform_Id": 12,
    "Package_Id": 465,
    "Name": "Under_Task"
}

Des informations supplémentaires sur la façon de créer des périphériques avec dotcom-monitor apis est disponible sur notre Wiki.

  • Test d'API avec facteur expliqué

    Qu’est-ce qu’une API ?

    Une API signifie interface de programmation d’applications – une interface qui permet aux applications de communiquer. L’API permet aux développeurs de logiciels d’envoyer des informations directement d’une application à l’autre, en contournant une interface utilisateur.

    Pour les tests et le développement de l’API, des outils spéciaux qui permettent d’envoyer des données d’entrée dans une demande et de vérifier si les données de sortie sont correctes sont largement utilisés. Facteur est l’un des outils comme celui-ci.

    Pourquoi utiliser Postman?

    Postman est un outil de test et de développement api qui est conçu pour envoyer des demandes du côté client vers le serveur Web et recevoir une réponse de l’arrière-bord. Les informations reçues avec la réponse sont déterminées par les données envoyées avec la demande. Ainsi, Postman est utilisé comme un client API pour vérifier les demandes client-serveur pour s’assurer que tout fonctionne sur le côté serveur comme il est prévu. Postman prend en charge les demandes aux services Web Restful, SOAP et GraphQL.

    Une interface graphique fait de Postman un outil facile à utiliser dans le processus de test et de développement de l’API.

    Vous pouvez télécharger Postman à partir de https://www.postman.com/downloads/.

    Pour tester les services Web Restful, Postman utilise les demandes HTTP pour envoyer des informations à une API. Une demande HTTP est un message HTTP qu’un client envoie à un serveur HTTP. En général, une demande HTTP contient une ligne de départ, un ensemble d’en-têtes HTTP et un corps.

    Une ligne de départ de la demande HTTP contient la méthode HTTP, URI de la ressource cible, et la version du protocole HTTP et a la structure suivante:

    MÉTHODE HTTP/ Cible URI/ VERSION HTTP

    Les méthodes HTTP déterminent l’action qui doit être effectuée sur la ressource. La signification des méthodes HTTP est décrite par la spécification du protocole. La spécification du protocole HTTP ne limite pas le nombre de méthodes différentes qui peuvent être utilisées. Cependant, seules quelques-unes des méthodes les plus standard sont utilisées pour prendre en charge la compatibilité avec un large éventail d’applications.

    Voici quelques-unes des méthodes HTTP qui peuvent être utilisées dans les appels API :

    • GET – pour obtenir (lire) des données (par exemple, une liste d’utilisateurs).
    • POST – pour créer de nouvelles données.
    • PUT / PATCH – pour mettre à jour les données.
    • SUPPRIMER – pour supprimer des données.
    • OPTIONS – pour obtenir une description complète des méthodes d’API disponibles sur le service.

    L’en-tête contient des métadonnées pour permettre à un client de transmettre des informations de clarification et de service sur la demande HTTP telles que l’encodage d’informations, les paramètres d’autorisation, etc.

    Les informations que vous souhaitez transférer sur le réseau sont transmises dans le corps. Le corps est facultatif et peut être laissé vide (selon les méthodes http et en-têtes).

    HTTP-response est les données qui reviennent du serveur API. Outre les données dans le corps, l’en-tête de réponse contient un code HTTP d’état de la réponse du serveur. Par exemple, vous pouvez recevoir les codes d’état suivants dans l’en-tête de réponse :

    • 200 – Succès;
    • 400 – Mauvaise demande;
    • 401 – Non autorisé.

    Travailler avec les demandes dans Postman

    En utilisant l’interface graphique Postman, il n’est pas nécessaire pour les développeurs web d’écrire leur propre code pour tester les fonctionnalités de l’API.

    Travailler avec les demandes dans Postman comprend la séquence suivante d’étapes :

    • Ajout d’une nouvelle demande HTTP à l’aide de l’interface Postman.
    • Personnalisation de la demande (spécification d’une méthode HTTP, en-tête, corps, paramètres d’authentification).
    • Exécution de la demande.
    • Enregistrement de la demande (p. ex., dans un dossier ou une collection).

    Tests chez Postman

    Pour traiter la réponse à partir du serveur, on peut créer différents tests dans Postman. Le test dans Postman est un code JavaScript qui est exécuté automatiquement après que le client a reçu une réponse à la demande. En d’autres termes, les tests postaux sont appliqués au résultat de la demande exécutée.

    Postman offre de nombreux extraits de code prêts à l’emploi que vous pouvez ajouter à votre test. Ici, vous pouvez trouver des extraits pour valider les codes et le contenu des réponses, parse et enregistrer des valeurs aux variables environnementales ou variables globales, vérifier leur conformité avec des valeurs spécifiées, etc. Par exemple, vous pouvez vérifier que le code d’état de la réponse à la demande GET est de 200. Les tests peuvent être appliqués non seulement à une seule demande, mais peuvent être déplacés vers un niveau de collecte.

    Collections postier

    Pour exécuter plusieurs requêtes une par une automatiquement, une collection de requêtes est utilisée dans Postman. Vous pouvez exécuter des collections remplies de demandes et de tests avec Collection Runner et les utiliser comme tests API automatisés. Pour exécuter une collection, vous pouvez sélectionner l’environnement, le nombre d’itérations dans la course et un délai entre les demandes. De plus, Postman supporte l’enregistrement des demandes et le stockage des variables et des cookies.

    Une fois qu’une collection de demandes a été créée, elle peut être exportée vers un fichier pour être utilisé dans une application tierce. Par exemple, Dotcom-Monitor prend en charge l’importation de Postman Collection à utiliser dans la configuration de surveillance et de test de charge.

    Notez que dans le cas où vous devez appeler une API qui nécessite l’authentification, la collecte des demandes à cette API doit inclure une demande POST au service d’authentification correspondant pour autoriser le client sur le serveur.

    En plus des fonctionnalités Postman décrites, vous pouvez paramétriser vos demandes, ajouter un point d’arrêt aux appels API et créer différents environnements pour vos demandes. Pour en savoir plus sur le travail avec Postman, consultez le site Web du Centre d’apprentissage postier https://learning.postman.com/.

    Comment l’API postier de Dotcom-Monitor peut vous aider

    L’utilisation de nos développeurs de logiciels de fonctionnalités API peut interagir avec leurs données de surveillance et de test de charge Dotcom-Monitor et tirer parti des résultats des tests Dotcom-Monitor dans une application tierce. L’intégration de Dotcom-Monitor avec d’autres applications est configurée via l’API REST, l’interface qui permet aux développeurs de logiciels de créer, lire et mettre à jour des données dans notre système.

    Pour configurer l’intégration avec les services Dotcom-Monitor, il faut utiliser le client Rest pour créer des requêtes vers notre API. Dans ce cas, il est recommandé d’utiliser Postman comme client De repos pour tester les appels HTTP à Dotcom-Monitor API d’une manière facile et rapide. En général, les paramètres de base sont réalisés à l’aide d’une interface graphique qui ne nécessite pas une connaissance approfondie des langages de programmation ou de l’expérience de développement logiciel.

    Une fois que l’intégration a été testée, vous pouvez implémenter les résultats dans un client de repos personnalisé, utiliser cURL ou procéder à l’aide de Postman.