API ஆவணமாக்கம்

EstaCaidoஐ உங்கள் பயன்பாடுகளுடன் ஒருங்கிணைக்கவும்

துவக்குதல்

EstaCaido API உங்களை உங்கள் கண்காணிப்புகளை நிர்வகிக்க, நிகழ்வுகளை பார்க்க, எச்சரிக்கைகளை வடிவமைக்க மற்றும் உங்கள் சொந்த குறியீட்டிலிருந்து மேலும் செய்ய அனுமதிக்கிறது. அனைத்து API முடிவு புள்ளிகளும் கோரிக்கை மற்றும் பதில் உடல்களுக்கு JSON ஐ பயன்படுத்துகின்றன.

அடிப்படை URL

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

விகித எல்லைகள்

ஒவ்வொரு API குறியும் நிமிடத்திற்கு 100 கோரிக்கைகளை உருவாக்க முடியும். அந்த வரம்புக்கு மேல் கோரிக்கைகள் 429 Too Many Requests பதில் பெறும்.

உரிமம்

அனைத்து API கோரிக்கைகளுக்கும் டாக்- அடிப்படையிலான உரிமத்தை பயன்படுத்து. உரிம தலைப்பில் உங்கள் டாக்- ஐ சேர்க்கவும்.

உரிமம்

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`	விருப்பத்தேர்வு	திரை அடையாளம் மூலம் வடிகட்டு

நிகழ்வை பெறு

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

எச்சரிக்கைகள்

Configure alert notifications for your monitors.

அலாரங்களை பட்டியலிடு

GET /api/v1/alerts/

அலாரத்தை உருவாக்கு

POST /api/v1/alerts/

அளபுருக்கள்

`monitor`	தேவைப்படும்	திரை அடையாளம்
`alert_type`	தேவைப்படும்	இந்த மதிப்புகளில் ஒன்று: email, sms, slack, discord, webhook, pagerduty, teams
`recipients`	தேவைப்படும்	பெறுநர் முகவரிகள் அல்லது வலைதள URLகள்
`alert_on_down`	விருப்பத்தேர்வு	தளம் நிறுத்தப்பட்டால் அறிவிக்கவும் (முன்னிருப்பு: உண்மை)
`alert_on_recovery`	விருப்பத்தேர்வு	தளம் மீளும்போது அறிவிக்கவும் (முன்னிருப்பு: உண்மை)

எச்சரிக்கையை புதுப்பி

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

அலாரத்தை நீக்கு

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

நிலை பக்கங்கள்

Create and manage public status pages.

நிலை பக்கங்களை பட்டியல் செய்

GET /api/v1/status-pages/

நிலைப் பக்கத்தை உருவாக்கு

POST /api/v1/status-pages/

அளபுருக்கள்

`title`	தேவைப்படும்	நிலைப் பக்கத்திற்கான தலைப்பு
`slug`	தேவைப்படும்	URL ஸ்லாக் (உ.ம். my-status-page)
`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 குறியை பெறு