API: Carteiro HTTP Solicita

Os exemplos abaixo descrevem várias solicitações comuns, incluindo autenticação, criação de dispositivos e tarefas, obtenção de uma lista de plataformas e obtenção de informações do dispositivo usando Carteiro (veja também como usar carteiro para testes de carga).

Para começar com a API Dotcom-Monitor, o cabeçalho HTTP/HTTPS deve ter o tipo de conteúdo definido como
aplicativo/json
.

Para obter os detalhes do Método API, consulte o artigo correspondente da categoria Métodos.

Para autenticação, use POST URI “/login“. Quando você faz login através da chamada “/login“, uma nova sessão de clientes começa. As sessões expiram automaticamente após um período predeterminado de inatividade. O padrão é de um minuto. Se você fizer uma chamada de API, o temporizador de inatividade será reiniciado a zero.

Quando sua sessão expira, o código de erro HTTP de exceção,”401 – Não autorizado”, é devolvido. Se isso acontecer, você deve fazer login novamente.

Recomenda-se usar seu UID de integração para login > > (UID de integração de conta).

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

{ 
"UID":"0E206D45650A4ACD8EB689B8CC25FA7F"
}

Obter plataformas

Para obter a lista de Plataformas de Monitoramento, use GET URI “
/platforms
“. Se a solicitação for bem sucedida, o servidor responderá com um código de status HTTP e a lista de todas as plataformas disponíveis. Recomenda-se salvar a resposta para usar os detalhes da sua conta (ID do pacote, ID de plataformas, ID do dispositivo, etc.) em solicitações subsequentes.

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

Criar um dispositivo

Use os dados recebidos na resposta “GET Platforms” para criar uma solicitação JSON. Os parâmetros do dispositivo que não estão especificados na solicitação serão definidos como padrão.

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

Criar uma tarefa

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

Obter e editar informações do dispositivo

Para editar as informações do dispositivo, primeiro, envie uma solicitação GET com o ID do dispositivo em URI para receber a resposta do servidor.

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

Em seguida, use o corpo de resposta para modificar os parâmetros do dispositivo e enviar de volta a solicitação JSON com novos valores.

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

Informações adicionais sobre como criar dispositivos com APIs do Dotcom-Monitor estão disponíveis em nosso Wiki.