Desteklenen başlıklar ve yollar
Temel adres https://api.redditapiproxy.com üzerindedir. Korumalı veri isteğinde Authorization: Bearer YOUR_API_KEY veya X-API-Key: YOUR_API_KEY kullanılır. İkisi de desteklenir; birini seçin. Bearer değeri bu arşivin anahtarıdır, Reddit OAuth belirteci değildir. Gerçek anahtarı sunucuda saklayın. Hesap panelinin Secure HttpOnly oturum çerezi, veri isteğinin anahtar başlığı yerine geçmez. Hesap, anahtar ve bakiye bu alana özgüdür.
GET /v1/search gönderi ve yorum arar; /v1/posts gönderileri, /v1/comments yorumları getirir. GET /v1/item?id=... kimliği bilinen tek kayıt içindir. id yalnızca item yolunda desteklenir ve posts veya comments filtresi değildir. GET /v1/subreddits?prefix=... topluluk adının başlangıcıyla sorgu yapar. limit istenen sonucu sınırlandırabilir; topluluk çıktısının tam envanter veya küresel olarak kesin sayım olduğu garanti edilmez.
GET /v1/status anahtarsız ve ücretsizdir. Sabit hizmet kapsamını ve HTTP uygulamasının yanıtını gösterir. Arşiv kaynağını, aramayı, kayıt varlığını, anahtarı veya bakiyeyi denetlemez. Status başarılı diye korumalı veri yolunun çalıştığını varsaymayın. Entegrasyonunuzun bu farklı yanıtları nasıl sunacağını belirleyin ve veri isteğinin kendi HTTP durumunu ayrıca kontrol edin.
Filtreler ve sınırlı kayıt sayfaları
Arama, gönderi ve yorum sorgularında q, subreddit, author, kind, from, to, min_score, limit ve page kullanılabilir. kind değerleri post veya comment biçimindedir. Tarihler UTC esaslı YYYY-MM-DD biçiminde gönderilir; to günü dahildir. min_score alt puan eşiğidir, sıralama değildir. parent_id ve link_id sorgu filtresi değildir. Başka yolların bütün bu arama parametrelerini kabul ettiğini varsaymayın.
limit 1–100, page 1–100 aralığındadır. İstek başına en fazla 100 kayıt ve sorgu başına en fazla 100 sayfa vardır. Her sayfa ayrı bir istektir. Arşiv belge sırası tarih, ilgi veya puan sırası değildir. Tarih dilimleri veya sayfa tekrarı tam kapsamı, değişmeyen sonucu ya da tekrarsız toplamayı kanıtlamaz. Hangi koşul ve sayfaları sakladığınızı kendi işlem kaydınızda izleyin.
Toplam kayıt sayısında eq kesin değeri, gte alt sınırı, unknown veya null güvenilir toplamın bulunmadığını belirtir. Bu sayfa sayısı değildir ve kesin toplam bile istemcinizin bütün kayıtları sakladığını kanıtlamaz. Yanıtlar düzdür; okumak ve saymak için ağaç gerekmez. İlişkiler için mevcut parent_id veya link_id ile isteğe bağlı yerel gruplama yapabilirsiniz; eksik üst kayıtlar ve yorumlar bu işlemle geri getirilemez.
Hata ve ücret ayrımı
HTTP 400 parametre biçiminin veya değerinin geçersiz olduğunu, HTTP 401 eksik ya da geçersiz anahtarı, HTTP 402 yetersiz bakiyeyi, HTTP 429 hız sınırını belirtir. 429 bağlantı zaman aşımı değildir. Parametre veya anahtar hatasını düzeltin, hız sınırında gönderimi erteleyin. Bir istemci bağlantı hatasıyla sunucunun döndürdüğü HTTP hata yanıtını aynı şey gibi değerlendirmeyin; müdahale ve tekrar kararı farklı olabilir.
Başarılı veri alma, boş sonuç dahil bir kredi harcar. Geçersiz istekten kredi düşülmez; üst kaynak hatasında ayrılan kredi geri verilir. İstemci yanıtı alamasa da sunucuda ücretli başarı gerçekleşmiş olabilir. Başarılı tekrar ek bir kredi tüketir. Sadece görünen hata sayısından ücretsiz işlem sonucu çıkarmayın. Yerel kaydetme durumunu inceleyerek ve gizli başlıkları yazmadan iş kimliğinizi takip ederek tekrar kararını değerlendirebilirsiniz.
