Dokumentace API

Integrujte EstaCaido s aplikacemi

Začínáme

EstaCaido API vám umožní spravovat monitory, zobrazit události, nakonfigurovat upozornění a další z vašeho vlastního kódu. Všechny API koncové body používají JSON pro účely žádosti a odpovědi.

Základní URL

https://www.estacaido.com/api/v1/

Mezní hodnoty sazeb

Každý API žeton může dostačit k požadavkům 100 za minutu. Žádosti o tento limit dostanete odpověď 429 Too Many Requests.

Ověření

Použijte token-based autentizaci pro všechny API požadavky. Zahrňte svůj token do hlavičky Autorizace.

Získat Autentizaci Token

POST /api/v1/auth/token/
Žádost
curl -X POST https://www.estacaido.com/api/v1/auth/token/ \
  -H "Content-Type: application/json" \
  -d '{"username": "your@email.com", "password": "yourpassword"}'
Odpověď
{
  "token": "your-api-token-here"
}

Použijte symbol v hlavičce Autorizace

Authorization: Token your-api-token-here

Monitory

Správa vašich webových stránek monitory.

Monitory seznamu

GET /api/v1/monitors/
Odpověď
[
  {
    "id": 1,
    "name": "Production API",
    "company": {
      "id": 1,
      "website": "api.example.com"
    },
    "check_type": "http",
    "check_interval": 300,
    "is_active": true,
    "is_paused": false,
    "last_check_at": "2024-01-15T10:30:00Z",
    "created_at": "2024-01-01T00:00:00Z"
  }
]

Vytvořit monitor

POST /api/v1/monitors/
Parametry
name Požadované Název monitoru
domain Požadované Doména pro monitorování, například example.com
check_interval Nepovinné Zkontrolovat interval v sekundách, jeden 30, 60, 300, 600, 900, 1800, 3600. Výchozí: 300
check_type Nepovinné Jedna z těchto hodnot: http, https, ping. Výchozí: https

Získat monitor

GET /api/v1/monitors/{id}/

Monitor aktualizace

PUT /api/v1/monitors/{id}/

Smazat monitor

DELETE /api/v1/monitors/{id}/

Pozastavit monitor

POST /api/v1/monitors/{id}/pause/

Obnovit monitor

POST /api/v1/monitors/{id}/resume/

Získat statistiky monitoru

GET /api/v1/monitors/{id}/statistics/
Parametry
days Nepovinné Počet dnů do zahrnutí. Výchozí: 30

Incidenty

Zobrazit události v čase a jejich historii.

Seznam incidentů

GET /api/v1/incidents/
Parametry
status Nepovinné Filtr podle stavu: probíhající, vyřešené
monitor Nepovinné Filtr pomocí ID monitoru

Získat incident

GET /api/v1/incidents/{id}/

Poplachy

Nastavte upozornění pro své monitory.

Seznam upozornění

GET /api/v1/alerts/

Vytvořit upozornění

POST /api/v1/alerts/
Parametry
monitor Požadované ID monitoru
alert_type Požadované Jedna z těchto hodnot: email, sms, slack, discord, webhook, pagerduty, teams
recipients Požadované URL adresy příjemce nebo webhook
alert_on_down Nepovinné Informujte o tom, kdy se stránka stáhne (výchozí: true)
alert_on_recovery Nepovinné Informujte o obnovení stránky (výchozí: true)

Aktualizovat upozornění

PUT /api/v1/alerts/{id}/

Smazat upozornění

DELETE /api/v1/alerts/{id}/

Stavové stránky

Vytvořit a spravovat veřejné stránky pro stav.

Seznam stran stavu

GET /api/v1/status-pages/

Vytvořit stránku stavu

POST /api/v1/status-pages/
Parametry
title Požadované Název stránky stavu
slug Požadované URL slimák (např. my-status-page)
description Nepovinné Text popisu
is_public Nepovinné Zpřístupnit veřejnosti (výchozí: true)

Týmy

Spravovat týmový přístup a spolupráci.

Seznam týmů

GET /api/v1/teams/

Vytvořit tým

POST /api/v1/teams/

Dostaňte tým.

GET /api/v1/teams/{id}/

Příklady kódů

Python

import requests

API_TOKEN = 'your-api-token'
BASE_URL = 'https://www.estacaido.com/api/v1'

headers = {
    'Authorization': f'Token {API_TOKEN}',
    'Content-Type': 'application/json'
}

# List all monitors
response = requests.get(f'{BASE_URL}/monitors/', headers=headers)
monitors = response.json()
print(monitors)

# Create a new monitor
new_monitor = {
    'name': 'My Website',
    'domain': 'example.com',
    'check_interval': 300
}
response = requests.post(f'{BASE_URL}/monitors/', json=new_monitor, headers=headers)
print(response.json())

JavaScript

const API_TOKEN = 'your-api-token';
const BASE_URL = 'https://www.estacaido.com/api/v1';

const headers = {
    'Authorization': `Token ${API_TOKEN}`,
    'Content-Type': 'application/json'
};

// List all monitors
fetch(`${BASE_URL}/monitors/`, { headers })
    .then(res => res.json())
    .then(monitors => console.log(monitors));

// Create a new monitor
fetch(`${BASE_URL}/monitors/`, {
    method: 'POST',
    headers,
    body: JSON.stringify({
        name: 'My Website',
        domain: 'example.com',
        check_interval: 300
    })
})
.then(res => res.json())
.then(data => console.log(data));

cURL

# List all monitors
curl -X GET https://www.estacaido.com/api/v1/monitors/ \
  -H "Authorization: Token your-api-token"

# Create a new monitor
curl -X POST https://www.estacaido.com/api/v1/monitors/ \
  -H "Authorization: Token your-api-token" \
  -H "Content-Type: application/json" \
  -d '{"name": "My Website", "domain": "example.com", "check_interval": 300}'

Připraveni začít?

Zaregistrujte se zdarma a získejte svůj API token začít integrovat.

Zaregistrujte se zdarma Získat API token