В приведенных ниже примерах описано несколько общих запросов, включая аутентификацию, создание устройств и задач, получение списка платформ и получение информации об устройстве с помощью Postman (см. также, как использовать Postman для тестирования нагрузки).

Для начала API Dotcom-Monitor заголовок HTTP/HTTPS должен иметь набор Content-Type для приложения/json.

 

Подробную информацию о методе API можно посмотреть в соответствующей статье из категории Методы.

Входа

Для проверки подлинности используйте POST URI” /login“. При входе в систему череззвонок «/логин»начинается новая клиентская сессия. Срок действия сеансов автоматически истекает после предопределенной продолжительности бездействия. Значение по умолчанию составляет одну минуту. При вызове API таймер бездействия сбрасывается до нуля.

По истечении срока действия сеанса возвращается код ошибки HTTP”401 – Несанкционированный. Если это произойдет, вы должны войти в систему снова.

Рекомендуется использовать интеграционное UID для входа в систему > (UID интеграции > учетной записи).

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

{ 
"UID":"0E206D45650A4ACD8EB689B8CC25FA7F"
}

Получить платформы

Чтобы получить список мониторинговых платформ, используйте GET URI “
/platforms
. Если запрос удался, сервер отвечает кодом статуса HTTP и списком всех доступных платформ. Рекомендуется сохранить ответ, чтобы использовать данные вашей учетной записи (идентификатор пакета, идентификатор платформ, идентификатор устройства и т.д.) в последующих запросах.

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

Создание устройства

Используйте данные, полученные в ответе “GET Platforms”, чтобы создать запрос JSON. Параметры устройства, которые не указаны в запросе, будут установлены по умолчанию.

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

Создание задачи

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

Получить и отредактировать информацию об устройстве

Для редактирования информации об устройстве, во-первых, отправьте запрос GET с идентификатором устройства в URI для получения ответа сервера.

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

Далее используйте тело ответа для изменения параметров устройства и отправки обратно запроса JSON с новыми значениями.

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

Дополнительная информация о том, как создавать устройства с помощью API Dotcom-Monitor, доступна на нашем сайте Wiki.

  • Тестирование API с почтальоном Разъяснения

    Что такое API?

    API означает интерфейс программирования приложений – интерфейс, который позволяет приложениям общаться. API позволяет разработчикам программного обеспечения отправлять информацию непосредственно из одного приложения в другое, минуя пользовательский интерфейс.

    Для тестирования и разработки API широко используются специальные инструменты, позволяющие отправлять входные данные в запросе и проверять правильность выходных данных. Почтальон является одним из инструментов, как это.

    Зачем использовать почтальона?

    Postman — это инструмент тестирования и разработки API, предназначенный для отправки запросов со стороны клиента на веб-сервер и получения ответа от бэкэнда. Информация, полученная с ответом, определяется данными, отправленными вместе с запросом. Таким образом, Postman используется в качестве клиента API для проверки запросов клиент-сервер, чтобы убедиться, что все работает на стороне сервера, как и ожидалось. Почтальон поддерживает запросы на веб-сервисы Restful, SOAP и Graph’L.

    Графический интерфейс делает Postman простым в использовании инструментом в процессе тестирования и разработки API.

    Вы можете скачать Почтальон из https://www.postman.com/downloads/.

    Для тестирования restful веб-сервисов Postman использует запросы HTTP для отправки информации в API. Запрос HTTP является http сообщением, которое клиент отправляет на сервер HTTP. Как правило, запрос HTTP содержит линию старта, набор заготовок HTTP и тело.

    Начало строки запроса HTTP содержит метод HTTP, URI целевого ресурса, а также версию протокола HTTP и имеет следующую структуру:

    Метод HTTP/ Целевая версия URI/ HTTP

    Методы HTTP определяют действие, которое должно выполняться на ресурсе. Значение методов HTTP описано в спецификации протокола. Спецификация протокола HTTP не ограничивает количество различных методов, которые могут быть использованы. Однако для обеспечения совместимости с широким спектром применений используются лишь некоторые из наиболее стандартных методов.

    Некоторые из методов HTTP, которые могут быть использованы в вызовов API являются:

    • GET – для сбора (читай) данных (например, список пользователей).
    • POST – для создания новых данных.
    • PUT / PATCH – для обновления данных.
    • DELETE – для удаления данных.
    • OPTIONS – получить полное описание методов API, доступных на сервисе.

    Заголовок содержит метаданные, позволяющие клиенту передавать уточняющую и сервисную информацию о запросе HTTP, такую как информация о кодировании, параметры авторизации и т.д.

    Информация, которую вы хотите передать по сети, передается в теле. Тело является необязательным и может быть оставлен пустым (в зависимости от методов HTTP и заготовок).

    HTTP-ответ — это данные, которые возвращаются с сервера API. Помимо данных в теле, заголовок ответа содержит код http-кода ответа сервера. Например, вы можете получить следующие коды статуса в заголовке ответов:

    • 200 – Успех;
    • 400 – Плохой запрос;
    • 401 – Несанкционированно.

    Работа с запросами в Почтальон

    Использование графического интерфейса Postman не нуждается в том, чтобы веб-разработчики писали свой собственный код для тестирования функций API.

    Работа с запросами в Postman включает в себя следующую последовательность шагов:

    • Добавление нового запроса HTTP с использованием интерфейса Postman.
    • Настройка запроса (указание метода HTTP, заголовка, тела, параметров аутентификации).
    • Выполнение запроса.
    • Сохранение запроса (например, в папке или коллекции).

    Тесты в Почтальоне

    Для обработки ответа с сервера можно создать различные тесты в Postman. Тест в Postman является JavaScript код, который выполняется автоматически после того, как клиент получил ответ на запрос. Другими словами, тесты Почтальона применяются к результату выполненного запроса.

    Почтальон предлагает множество готовых к использованию фрагментов кода, которые можно добавить в тест. Здесь можно найти фрагменты для проверки кодов и содержания ответов, анализа и сохранения значений переменных среды или глобальных переменных, проверки их соответствия заданным значениям и т.д. Например, можно проверить, что код статуса ответа на запрос GET составляет 200. Тесты могут быть применены не только к одному запросу, но могут быть перемещены на уровень сбора.

    Почтовые коллекции

    Для выполнения нескольких запросов один за другим автоматически в Postman используется коллекция запросов. Вы можете запускать коллекции, заполненные запросами и тестами, с Помощью Collection Runner и использовать их в качестве автоматизированных тестов API. Для запуска коллекции можно выбрать среду, количество итераций в запуске и задержку между запросами. Кроме того, Почтальон поддерживает регистрацию запросов и хранение переменных и файлов cookie.

    После создания коллекции запросов она может быть экспортирована в файл, который будет использоваться в сторонняя заявка. Например, Dotcom-Monitor поддерживает импорт Postman Collection для использования в настройках мониторинга и тестирования нагрузки.

    Обратите внимание, что в случае необходимости вызова API, который требует проверки подлинности, сбор запросов на этот API должен включать запрос POST в соответствующую службу аутентификации для авторизации клиента на сервере.

    В дополнение к описанным функциям Postman, вы можете параметризировать ваши запросы, добавить точку разрыва в вызовы API и создать различные среды для ваших запросов. Чтобы узнать больше о работе с почтальоном, проверьте сайт Почтового учебного центра https://learning.postman.com/.

    Как ПОЧТОВЫй API Dotcom-Monitor может помочь вам

    Используя наши функциональные программы API, разработчики могут взаимодействовать с их данными мониторинга Dotcom-Monitor и загружать данные тестирования и использовать результаты тестов Dotcom-Monitor в сторонняя приложение. Интеграция Dotcom-Monitor с другими приложениями настроена через REST API, интерфейс, который позволяет разработчикам программного обеспечения создавать, читать и обновлять данные в нашей системе.

    Для настройки интеграции с службами Dotcom-Monitor необходимо использовать клиента Rest для создания запросов на наш API. В этом случае рекомендуется использовать Postman в качестве клиента отдыха для проверки вызовов HTTP на DOTcom-Monitor API простым и быстрым способом. Как правило, основные настройки сделаны с использованием графического интерфейса, который не требует глубокого знания языков программирования или опыта разработки программного обеспечения.

    После того, как интеграция была протестирована, вы можете реализовать результаты в пользовательском клиенте отдыха, использовать cURL или продолжить использование Почтальона.