API Dokümantasyonu

Bu, REST mimarisi etrafında inşa edilmiş olan mevcut API uç noktaları için belgedir. Tüm API uç noktaları, standart HTTP yanıt kodları ile birlikte bir API Anahtarı aracılığıyla Bearer Kimlik Doğrulaması gerektirir.

 
Kendi API Anahtarınızı alın

Kimlik doğrulama

Tüm API uç noktaları, Taşıyıcı Kimlik Doğrulama yöntemi tarafından gönderilen bir API anahtarı gerektirir.

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://popupke.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Hatalar

API’miz, bir isteğin başarısını veya başarısızlığını belirtmek için geleneksel HTTP durum kodlarını kullanır.

{
    "errors": [
        {
            "title": "API'ye eri\u015fiminiz yok.",
            "status": 401
        }
    ]
}
200 İstek başarıyla tamamlandı
400 Hatalı istek - Gerekli parametreler eksik veya geçersiz
401 Yetkisiz - API anahtarı eksik veya geçersiz
404 İstenen kaynak bulunamadı
429 Çok fazla istek - Hız sınırı aşıldı
500 Dahili sunucu hatası - bu, bizim tarafımızda bir sorun olduğu anlamına gelir
Belirtilmedikçe, tüm API uç noktası sonuçları UTC saat dilimi ile çalışır.
Kullanıcı
İstatistik
Kampanyalar
Kampanya Bildirimleri
Bildirim işleyicileri
Takımlarım
Takım üyeleri
Ekip üyesi
Hesap Logları