In den folgenden Beispielen werden mehrere häufige Anforderungen beschrieben, darunter Authentifizierung, Geräte- und Aufgabenerstellung, Abrufen einer Liste von Plattformen und Abrufen von Geräteinformationen mithilfe von Postman (siehe auch Die Verwendung von Postman für Auslastungstests).

Um mit der Dotcom-Monitor-API zu beginnen, muss der HTTP/HTTPS-Header Content-Type auf application/jsonfestgelegt haben.

Die Details zur API-Methode finden Sie im entsprechenden Artikel aus der Kategorie Methoden.

einloggen

Verwenden Sie für die Authentifizierung den POST-URI “/login“. Wenn Sie sich über den Anruf “/login” anmelden, beginnt eine neue Clientsitzung. Sitzungen laufen automatisch nach einer vorgegebenen Dauer der Inaktivität ab. Der Standardwert ist eine Minute. Wenn Sie einen API-Aufruf durchführen, wird der Inaktivitätszeitgeber auf Null zurückgesetzt.

Wenn Ihre Sitzung abläuft, wird der HTTP-Ausnahmefehlercode””401 – Unauthorized” zurückgegeben. In diesem Fall müssen Sie sich erneut anmelden.

Es wird empfohlen, Ihre Integrations-UID für die Anmeldung zu verwenden (Konto Integration > > UID).

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

{ 
"UID":"0E206D45650A4ACD8EB689B8CC25FA7F"
}

Get Platforms

Um die Liste der Überwachungsplattformen abzudateien, verwenden Sie GET URI “
/platforms
“. Wenn die Anforderung erfolgreich ist, antwortet der Server mit einem HTTP-Statuscode und der Liste aller verfügbaren Plattformen. Es wird empfohlen, die Antwort zu speichern, um Ihre Kontodaten (Paket-ID, Plattform-ID, Geräte-ID usw.) in nachfolgenden Anforderungen zu verwenden.

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

Erstellen eines Geräts

Verwenden Sie die in der Antwort “GET-Plattformen” empfangenen Daten, um eine JSON-Anforderung zu erstellen. Die Geräteparameter, die nicht in der Anforderung angegeben sind, werden auf Standard festgelegt.

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"
}

Erstellen einer Aufgabe

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"
}

Abrufen und Bearbeiten von Geräteinformationen

Um Geräteinformationen zu bearbeiten, senden Sie zunächst eine GET-Anforderung mit der Geräte-ID im URI, um die Serverantwort zu empfangen.

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

Verwenden Sie als Nächstes den Antworttext, um Geräteparameter zu ändern und die JSON-Anforderung mit neuen Werten zurückzusenden.

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"
}

Weitere Informationen zum Erstellen von Geräten mit Dotcom-Monitor-APIs finden Sie in unserem Wiki.

  • Testen von APIs mit Postman Explained

    Was ist eine API?

    Eine API steht für Application Programming Interface – eine Schnittstelle, die es Anwendungen ermöglicht, zu kommunizieren. Die API ermöglicht es Softwareentwicklern, Informationen direkt von einer App an eine andere zu senden und dabei eine Benutzeroberfläche zu umgehen.

    Für API-Tests und -Entwicklung werden spezielle Tools verwendet, die es ermöglichen, Eingabedaten in einer Anforderung zu senden und zu überprüfen, ob die Ausgabedaten korrekt sind. Postman ist eines der Werkzeuge wie dieses.

    Warum Postman verwenden?

    Postman ist ein API-Test- und Entwicklungstool, das entwickelt wurde, um Anforderungen von der Clientseite an den Webserver zu senden und eine Antwort vom Back-End zu erhalten. Die mit der Antwort empfangenen Informationen werden durch die zusammen mit der Anforderung gesendeten Daten bestimmt. Daher wird Postman als API-Client verwendet, um Client-Server-Anforderungen zu überprüfen, um sicherzustellen, dass alles auf der Serverseite wie erwartet funktioniert. Postman unterstützt Anfragen an Restful-, SOAP- und GraphQL-Webdienste.

    Eine grafische Oberfläche macht Postman zu einem benutzerfreundlichen Tool im API-Test- und -Entwicklungsprozess.

    Sie können Postman von https://www.postman.com/downloads/herunterladen.

    Zum Testen von Restful-Webdiensten verwendet Postman HTTP-Anforderungen, um Informationen an eine API zu senden. Eine HTTP-Anforderung ist eine HTTP-Nachricht, die ein Client an einen HTTP-Server sendet. Im Allgemeinen enthält eine HTTP-Anforderung eine Startzeile, eine Gruppe von HTTP-Headern und einen Text.

    Eine Startzeile der HTTP-Anforderung enthält die HTTP-Methode, den URI der Zielressource und die Version des HTTP-Protokolls und weist die folgende Struktur auf:

    HTTP-Methode/ Ziel-URI/ HTTP-Version

    HTTP-Methoden bestimmen die Aktion, die für die Ressource ausgeführt werden muss. Die Bedeutung von HTTP-Methoden wird durch die Protokollspezifikation beschrieben. Die HTTP-Protokollspezifikation beschränkt nicht die Anzahl der verschiedenen Methoden, die verwendet werden können. Es werden jedoch nur einige der Standardmethoden verwendet, um die Kompatibilität mit einer Vielzahl von Anwendungen zu unterstützen.

    Einige der HTTP-Methoden, die in API-Aufrufen verwendet werden können, sind:

    • GET – um Daten (z.B. eine Benutzerliste) zu erhalten (lesen).
    • POST – um neue Daten zu erstellen.
    • PUT / PATCH – um Daten zu aktualisieren.
    • DELETE – um Daten zu löschen.
    • OPTIONEN – um eine vollständige Beschreibung der API-Methoden zu erhalten, die für den Dienst verfügbar sind.

    Der Header enthält Metadaten, damit ein Client klärende und Dienstinformationen über die HTTP-Anforderung übergeben kann, z. B. Codierungsinformationen, Autorisierungsparameter usw.

    Informationen, die Sie über das Netzwerk übertragen möchten, werden im Text übergeben. Der Text körper ist optional und kann leer gelassen werden (abhängig von den HTTP-Methoden und Headern).

    HTTP-Response ist die Daten, die vom API-Server zurückkommen. Neben den Daten im Textkörper enthält der Antwortheader einen Status-HTTP-Code der Serverantwort. Sie können z. B. die folgenden Statuscodes im Antwortkopf erhalten:

    • 200 – Erfolg;
    • 400 – Ungültige Anfrage;
    • 401 – Nicht autorisiert.

    Arbeiten mit Anfragen in Postman

    Mithilfe der grafischen Benutzeroberfläche von Postman müssen Webentwickler keinen eigenen Code schreiben, um API-Funktionen zu testen.

    Die Arbeit mit Anforderungen in Postman umfasst die folgende Reihenfolge von Schritten:

    • Hinzufügen einer neuen HTTP-Anforderung mithilfe der Postman-Schnittstelle.
    • Anpassen der Anforderung (Angabe einer HTTP-Methode, eines Headers, eines Textes, einer Authentifizierungsparameter).
    • Ausführung der Anforderung.
    • Speichern der Anforderung (z. B. in einem Ordner oder einer Sammlung).

    Tests in Postman

    Um die Antwort vom Server zu verarbeiten, kann man verschiedene Tests in Postman erstellen. Der Test in Postman ist ein JavaScript-Code, der automatisch ausgeführt wird, nachdem der Client eine Antwort auf die Anforderung erhalten hat. Mit anderen Worten, Postman-Tests werden auf das Ergebnis der ausgeführten Anforderung angewendet.

    Postman bietet viele gebrauchsfertige Codeausschnitte, die Sie Ihrem Test hinzufügen können. Hier finden Sie Ausschnitte, um die Codes und den Inhalt von Antworten zu überprüfen, Werte in Umgebungs- oder globalen Variablen zu analysieren und zu speichern, deren Übereinstimmung mit bestimmten Werten zu überprüfen usw. Sie können z. B. überprüfen, ob der Statuscode der Antwort auf die GET-Anforderung 200 ist. Tests können nicht nur auf eine einzelne Anforderung angewendet werden, sondern auch auf eine Auflistungsebene verschoben werden.

    Postman Collections

    Um mehrere Anforderungen nacheinander automatisch auszuführen, wird in Postman eine Auflistung von Anforderungen verwendet. Sie können Sammlungen ausführen, die mit Anforderungen und Tests mit Collection Runner ausgefüllt sind, und sie als automatisierte API-Tests verwenden. Um eine Auflistung auszuführen, können Sie die Umgebung, die Anzahl der Iterationen in der Ausführung und eine Verzögerung zwischen Anforderungen auswählen. Darüber hinaus unterstützt Postman die Protokollierung von Anfragen und das Speichern von Variablen und Cookies.

    Sobald eine Auflistung von Anforderungen erstellt wurde, kann sie in eine Datei exportiert werden, die in einer Drittanbieteranwendung verwendet werden soll. Dotcom-Monitor unterstützt beispielsweise den Import von Postman Collection zur Verwendung bei der Überwachung und beim Einrichten von Auslastungstests.

    Beachten Sie, dass die Auflistung der Anforderungen an diese API eine POST-Anforderung an den entsprechenden Authentifizierungsdienst enthalten muss, um den Client auf dem Server zu autorisieren, wenn Sie eine API aufrufen müssen, die eine Authentifizierung erfordert.

    Zusätzlich zu den beschriebenen Postman-Features können Sie Ihre Anforderungen parametrisieren, API-Aufrufen einen Haltepunkt hinzufügen und verschiedene Umgebungen für Ihre Anforderungen erstellen. Weitere Informationen zur Arbeit mit Postman finden Sie auf der Website des Postman Learning Center https://learning.postman.com/.

    Wie Die Postman-API von Dotcom-Monitor Ihnen helfen kann

    Mit unserer API-Funktionalität können Softwareentwickler mit ihren Dotcom-Monitor-Überwachungs- und Auslastungstestdaten interagieren und die Ergebnisse von Dotcom-Monitor-Tests in einer Drittanbieteranwendung nutzen. Die Integration von Dotcom-Monitor mit anderen Anwendungen wird über die REST-API konfiguriert, die Schnittstelle, die es Softwareentwicklern ermöglicht, Daten in unserem System zu erstellen, zu lesen und zu aktualisieren.

    Um die Integration mit Dotcom-Monitor-Diensten einzurichten, muss man den Rest-Client verwenden, um Anforderungen an unsere API zu erstellen. In diesem Fall wird empfohlen, Postman als Rest-Client zu verwenden, um die HTTP-Aufrufe der Dotcom-Monitor-API auf einfache und schnelle Weise zu testen. Im Allgemeinen werden grundlegende Einstellungen über eine grafische Oberfläche vorgenommen, die keine tiefen Kenntnisse der Programmiersprachen oder Softwareentwicklungserfahrung erfordert.

    Nachdem die Integration getestet wurde, können Sie die Ergebnisse in einem benutzerdefinierten Rest-Client implementieren, cURL verwenden oder mit Postman fortfahren.