Les exemples ci-dessous décrivent plusieurs demandes courantes, notamment 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 les appareils à l’aide de Postman (voir également comment utiliser Postman pour les tests de charge).

Pour commencer avec l’API Dotcom-Monitor, l’en-tête HTTP/HTTPS doit avoir Content-Type défini sur
application/json
.

Pour plus d’informations sur la méthode API, consultez l’article correspondant de la catégorie Méthodes.

connectez-vous

Pour l’authentification, utilisez l’URI POST « /login«. Lorsque vous vous connectez via l’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 renvoyé. Si cela se produit, vous devez vous connecter à nouveau.

Il est recommandé d’utiliser votre UID d’intégration pour vous connecter ( > Account Integration > UID).

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

{ 
"UID":"0E206D45650A4ACD8EB689B8CC25FA7F"
}

Obtenir des plateformes

Pour obtenir la liste des plates-formes 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 plates-formes disponibles. Il est recommandé d’enregistrer la réponse afin d’utiliser les détails de votre compte (ID de package, ID de plateforme, ID d’appareil, 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 « Get Platforms » pour créer une requête JSON. Les paramètres de périphérique 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://www.dotcom-monitor.com",
"Device_Id":123456,
"RequestType":"GET",
"Task_Type_Id":2,
"DNSResolveMode":"Device Cached"
}

Obtenir et modifier les informations sur l’appareil

Pour modifier les informations sur l’appareil, envoyez d’abord une requête GET avec l’ID de l’appareil dans l’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 la réponse pour modifier les paramètres du périphérique et renvoyer la requête 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 création d’appareils avec les API Dotcom-Monitor sont disponibles sur notre Wiki.