API Sənədi
Bu, REST arxitekturası ətrafında qurulmuş mövcud API son nöqtələri üçün sənəddir. Bütün API son nöqtələri standart HTTP cavab kodları ilə JSON cavabı qaytaracaq və API Açarı vasitəsilə Bearer Təsdiqi tələb edir.
Təsdiqləmə
Bütün API son nöqtələri Bearer Authentication metodu ilə göndərilən bir API açarı tələb edir.
Authorization: Bearer {api_key}
curl --request GET \
--url 'https://uptimeset.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://uptimeset.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
Xətalar
API-miz sorğunun uğurunu və ya uğursuzluğunu göstərmək üçün ənənəvi HTTP status kodlarından istifadə edir.
{
"errors": [
{
"title": "Siz API-y\u0259 giri\u015f\u0259 malik deyilsiniz.",
"status": 401
}
]
}
200 Sorğu uğurla tamamlandı
400 Səhv sorğu - Lazımi parametrlər çatışmır və ya etibarsızdır
401 İcazəsiz - API açarı yoxdur və ya etibarsızdır
404 Tələb olunan resurs tapılmadı
429 Çox sayda sorğu - Sürət limiti aşılıb
500 Daxili server xətası - bu o deməkdir ki, problem bizim tərəfimizdədir
Bütün API son nöqtəsi nəticələri UTC zaman zonasını istifadə edir, əgər başqa cür göstərilməyibsə.
İstifadəçi
Uptime monitorları
DNS monitorları
Server monitorları
Ürək döyüntüləri
Domen adları
Bildiriş idarəediciləri
Hadisələr
Hesab ödənişləri
Hesab qeydləri