API sənədləri

API-mizə necə qoşulub onu inteqrasiya etməyi öyrənin.

 

Doğrulama

Bütün API endpoint-ləri Bearer təsdiqləmə üsulu ilə göndərilən API açarı tələb edir.

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://push.yayim.org/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Xətalar

API sorğunun uğurunu və ya uğursuzluğunu göstərmək üçün standart HTTP status kodlarından istifadə edir.

{
    "errors": [
        {
            "title": "API-y\u0259 giri\u015f icaz\u0259niz yoxdur.",
            "status": 401
        }
    ]
}
200 Sorğu uğurla tamamlandı
400 Yanlış sorğu — məcburi parametrlər yoxdur və ya yanlışdır
401 İcazəsiz — API açarı yoxdur və ya yanlışdır
404 İstənilən resurs tapılmadı
429 Həddən artıq sorğu — sorğu limiti aşılıb
500 Daxili server xətası — problem xidmət tərəfindədir
Başqa cür göstərilmədikdə bütün API nəticələri UTC saat qurşağında verilir.
İstifadəçi
Saytlar
Abunəçilər
Abunəçi statistikası
Abunəçi qeydləri
Kampaniyalar
Fərdi bildirişlər
RSS avtomatlaşdırmaları
Təkrarlanan kampaniyalar
Axınlar
Seqmentlər
Bildiriş kanalları
Xüsusi domenlər
Hesab jurnalları