Ҳуҷҷатҳо

Якҷоя кардани EstaCaido бо барномаҳои худ

Оғоз кардан

API-и EstaCaido ба шумо имкон медиҳад, ки мониторҳои худро идора кунед, ҳодисаҳоро бубинед, огоҳӣ ва ғайраро аз рамзи худ танзим кунед. Ҳамаи нуқтаҳои охири API JSON-ро барои дархости дархост ва ҷавоб истифода мебаранд.

URL- и асосӣ

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

Маҳдудияти суръат

Ҳар як API- и нишона метавонад то 100 дархостҳоро дар як дақиқа ташкил диҳад. Дархостҳо аз ин ҳад зиёд ҷавоби 429 Too Many Requests мегиранд.

Аслшиносӣ

Истифодаи аутентификацияи асосӣ барои ҳамаи дархостҳои API. Аутентификацияи худро дар сарлавҳаи Authorization дохил кунед.

Гирифтани нишонаи аслшиносӣ

POST /api/v1/auth/token/
Дархости нав
curl -X POST https://www.estacaido.com/api/v1/auth/token/ \
  -H "Content-Type: application/json" \
  -d '{"username": "your@email.com", "password": "yourpassword"}'
Ҷавоб
{
  "token": "your-api-token-here"
}

Истифодаи нишона дар сарлавҳаи & иҷозатдиҳӣ

Authorization: Token your-api-token-here

Мониторҳо

Идоракунии мониторингҳои вебсайти шумо.

Рӯйхати Мониторҳо

GET /api/v1/monitors/
Ҷавоб
[
  {
    "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"
  }
]

Монитор эҷод кунед

POST /api/v1/monitors/
Параметрҳо
name Дархостӣ Номи монитор
domain Дархостӣ Домен барои назорат, масалан example.com
check_interval Интихоби Фосилаи санҷиш дар сонияҳо, яке аз 30, 60, 300, 600, 900, 1800, 3600. Бо нобаёнӣ: 300
check_type Интихоби Яке аз ин маъноҳо: http, https, ping. Пешфарз: https

Гирифтани Монитор

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

Навсозии Монитор

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

Нест кардани Монитор

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

Монитори таъхир

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

Монитори давомдиҳӣ

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

Гирифтани статистикаи монитор

GET /api/v1/monitors/{id}/statistics/
Параметрҳо
days Интихоби Миқдори рӯзҳо барои дохилкунӣ. Пешфарз: 30

Ҳодисаҳо

Намоиши ҳодисаҳои қатъ ва таърихи онҳо.

Рӯйхати ҳодисаҳо

GET /api/v1/incidents/
Параметрҳо
status Интихоби Филтронӣ аз рӯи вазъият: идома дорад, ҳал шудааст
monitor Интихоби Филтр аз рӯи ID- и монитор

Гирифтани ҳодиса

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

Огоҳӣ

Configure alert notifications for your monitors.

Рӯйхати огоҳномаҳо

GET /api/v1/alerts/

Эҷоди хотиррасонӣ

POST /api/v1/alerts/
Параметрҳо
monitor Дархостӣ ID- и экран
alert_type Дархостӣ Яке аз ин арзишҳо: email, sms, slack, discord, webhook, pagerduty, teams
recipients Дархостӣ Адресҳои қабулкунанда ё URL- ҳои webhook
alert_on_down Интихоби Огоҳӣ диҳед, вақте ки сайт аз кор мебарояд (бо нобаёнӣ: ҳақиқат)
alert_on_recovery Интихоби Огоҳӣ диҳед, вақте ки сайт барқарор мешавад (бо нобаёнӣ: ҳақиқат)

Бозсозии огоҳӣ

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

Нест кардани хотиррасонӣ

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

Саҳифаҳои вазъият

Эҷод ва идоракунии саҳифаҳои ҳолати ҷамъиятӣ.

Рӯйхати саҳифаҳои вазъият

GET /api/v1/status-pages/

Сохтани саҳифаи вазъият

POST /api/v1/status-pages/
Параметрҳо
title Дархостӣ Сарлавҳаи саҳифаи вазъият
slug Дархостӣ URL slug (масалан, саҳифаи ҳолати ман)
description Интихоби Матни тавсифот
is_public Интихоби Дастрасии умумӣ (бо нобаёнӣ: ҳақ)

& Гурӯҳҳо

Идоракунии дастрасӣ ва ҳамкории даста.

Рӯйхати дастаҳо

GET /api/v1/teams/

Эҷод кардани гурӯҳ

POST /api/v1/teams/

Гирифтани даста

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

Намунаҳои рамз

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

Барои оғоз кардан омодаед?

Барои ройгон сабти ном шудан ва барои оғози ҳамгироӣ, нишони API- ро гиред.

Бақайдгирии ройгон Гирифтани нишонаи API