API

1 ano ago

6 minutes

Autenticação

Ter acesso ao recurso do sistema de API, é necessário que o usuário ative o recurso em sua conta e, em seguida, gere uma credencial exclusiva. Essa credencial será utilizada para autenticação ao realizar chamadas.

Planos Gratuitos

Cada conta tem acesso a apenas uma única chave por vez.
É obrigatório vincular a chave a um endereço IP específico.
Apenas requisições vindas do IP autorizado serão aceitas, garantindo conformidade com as regras de rate limit (limitação de requisições por minuto).
Caso seja necessário utilizar a chave em outro ambiente, o usuário deve atualizar o endereço IP vinculado à chave na dashboard antes de realizar novas consultas, esse recurso é disponível há cada 24 horas.

Planos PRO

Os usuários PRO podem gerar múltiplas chaves, conforme os limites do plano contratado.
Não há necessidade de vincular um IP específico, ou seja, as chaves podem ser utilizadas em diferentes dispositivos, servidores e redes sem restrição de IP.
Essa flexibilidade permite o uso da mesma chave em múltiplos locais simultaneamente.

Como gerar sua chave

Para gerar sua chave, acesse sua conta na dashboard do Meu Uptime, no menu localize a seção de Conta e em seguida localize o menu API.

Regras de Rate Limite

O sistema foi desenvolvido com foco em otimização e conta com um mecanismo autônomo para prevenir abusos.

Limites de Requisições:

Planos Gratuitos: Limitados a 15 requisições por minuto.
Planos PRO: O limite de requisições varia conforme o plano contratado e ativo.

Recursos disponíveis

Consulta de listagem de monitores: Permite visualizar todos os monitores cadastrados em sua conta.
Consulta de monitores específicos: Acesso detalhado às informações de um monitor específico.
Rastreamento de Domínios (Exclusivo para Planos PRO): Permitindo o rastreamento detalhado de domínios de interesse.

Modo de utilização

Consulta de listagem de monitores

GET https://api.meuuptime.com.br/monitores?chave_api=SUA_CHAVE&listar

Consulta de monitores específicos

GET https://api.meuuptime.com.br/monitores?chave_api=SUA_CHAVE&uid=UID_MONITOR

Consulta de rastreadores de domínios

GET https://api.meuuptime.com.br/monitores?chave_api=SUA_CHAVE&dominios

Consulta de blacklist

GET https://api.meuuptime.com.br/monitores?chave_api=SUA_CHAVE&blacklist

Retornos aguardados

Consulta de listagem de monitores

{
    {
        "nome": "DNS 1.1.1.1",
        "uid": "UID_MONITOR",
        "tipo": "porta",
        "endereco": "1.1.1.1",
        "inverso": "1",        
        "status": "0"
    },
    {
        "nome": "DNS 1.0.0.1",
        "uid": "UID_MONITOR",
        "tipo": "porta",
        "endereco": "1.0.0.1",
        "inverso": "0",        
        "status": "0"
    }
}

Consulta de monitores específicos

{
    "nome": "DNS 1.1.1.1",
    "uid": "UID_MONITOR",
    "tipo": "porta",
    "endereco": "1.1.1.1",
    "inverso": "1",    
    "status": "0"
}

Consulta de rastreadores de domínios

{
    {
        "endereco": "facebook.com.br",
        "registro": "2025-02-18 14:05:10",
        "vencimento": "2025-02-18 14:05:10",
        "rastreamento": "2025-02-18 14:05:10",
        "status": "0",
        "ultima_notificacao": null
    },
    {
        "endereco": "google.com.br",
        "registro": "2025-02-18 14:05:10",
        "vencimento": "2025-02-18 14:05:10",
        "rastreamento": "2025-02-18 14:05:10",
        "status": "0",
        "ultima_notificacao": "2025-02-18 14:05:10",
    }
  }

Consulta de blacklist

[
    {
        "ip": "192.0.0.1",
        "status": "2",
        "data_criacao": "2025-02-18 22:05:39",
        "atualizacao": "2025-02-18 06:52:00"
    },
    {
        "ip": "127.0.0.1",
        "status": "1",
        "data_criacao": "2025-02-18 22:05:39",
        "atualizacao": "2025-02-18 06:52:00"
    },
    {
        "ip": "127.0.0.1",
        "status": "0",
        "data_criacao": "2025-02-18 22:05:39",
        "atualizacao": "2025-02-18 06:52:00"
    },    
]

Retornos de erros

Recurso não disponível, o recurso solicitado não está disponível para sua conta. Algumas funcionalidades são exclusivas para planos PRO ativos.

{
    "error": "Recurso não disponível para a sua conta."
}

Se você possui um plano PRO ativo e ainda assim recebeu esse erro, entre em contato com nosso suporte para que possamos verificar o ocorrido.

Chave de API inválida, inativa ou IP não autorizado, esse erro indica que o sistema não conseguiu verificar sua identificação ao tentar acessar um recurso.

{
    "error": "Chave API inválida, inativa ou IP não autorizado"
}

✔ Chave incorreta ou inativa: Verifique se a chave utilizada está correta e se está ativa para uso.

✔ Restrições de IP: Se sua conta exige um IP autorizado, certifique-se de que o endereço IP/hostname está cadastrado corretamente.

Para corrigir, acesse: Dashboard → Conta → API e verifique as configurações.

Limite de requisições excedido, esse erro ocorre quando sua chave de API atinge o limite máximo permitido pelas regras de rate limit.

{
    "error": "Limite de requisições excedido"
}

✔ Verifique suas aplicações para garantir que nenhuma está realizando consultas além do limite estabelecido.

✔ Utilize restrições de consultas por IP/hostname para impedir acessos não autorizados, aumentando significativamente a segurança do recurso.

✔ Caso necessário, ajuste a frequência das requisições ou considere um upgrade para um plano PRO para obter limites mais elevados.

Como obter o UI_MONITOR

Para obter o UID_MONITOR de um monitor específico, utilize primeiro o recurso de listagem de monitores. A resposta dessa consulta incluirá todos os seus monitores, e no retorno haverá um campo chamado uid, que corresponde ao UID_MONITOR necessário para consultas específicas.

Onde utilizar o sistema de API

O recurso de API pode ser utilizado em múltiplos ambientes, o sistema pode ser adaptado a sistemas como python, n8n, shell e outros serviços.

Algo como:

#API