Yollar ve yetkilendirme
Temel adres https://api.redditfetch.com üzerindedir. GET /v1/search gönderi ve yorum arar; /v1/posts gönderileri, /v1/comments yorumları getirir. GET /v1/item?id=... belirli bir kaydı kimliğiyle ister. id yalnızca item yolu içindir; posts veya comments üzerinde desteklenen bir filtre değildir. GET /v1/subreddits?prefix=... topluluk adının başlangıcıyla sorgu yapar. Topluluk sonuçlarının küresel olarak kesin sayımlar olduğunu varsaymayın.
Veri alma istekleri Authorization: Bearer YOUR_API_KEY ve X-API-Key: YOUR_API_KEY başlıklarının ikisini de destekler. Birini seçip gerçek anahtarı yalnızca sunucudan gönderin. Hesap panelindeki Secure HttpOnly oturum çerezi farklı bir göreve sahiptir; API anahtarı yerine geçmez. Anahtar, hesap ve bakiye bu alan adına özgüdür. Başka ağ markasının anahtarıyla burada aynı hesaba erişemezsiniz.
GET /v1/status herkese açık ve ücretsizdir. Sabit hizmet kapsamı açıklamasını ve HTTP uygulamasının yanıt verdiğini gösterir. Arşiv kaynağını, sorgu çalışmasını, kayıtların varlığını veya bakiyeyi kontrol etmez. Ön kontrol olarak kullanırsanız bu sınırı koruyun. Durum yanıtı başarılı diye sonraki veri isteğini veya kullanıcıya gösterilecek sonuçları otomatik olarak başarılı kabul etmeyin.
Filtreler ve sayfalama
Arama, gönderi ve yorum sorgularında q, subreddit, author, kind, from, to, min_score, limit ve page kullanılabilir. kind değerleri post ve comment biçimindedir. Tarihleri UTC esaslı YYYY-MM-DD olarak gönderin; to belirtilen günün tamamını kapsar. min_score alt puan eşiğidir, sıralama seçeneği değildir. parent_id ve link_id sorgu filtreleri değildir; kimlikleri bu yollara ekleyerek konuşma getirme özelliği oluşturamazsınız.
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 alınabilir. Her sayfa ayrı istenir. Arşiv belge sırası kronolojik, ilgi veya puan sırası değildir. Ardışık sayfalar ya da daha dar tarih aralıkları bütün eşleşmeleri aldığınızı veya tekrar bulunmadığını kanıtlamaz. İstemcinizde hangi koşul ve sayfaları kaydettiğinizi takip edin.
Toplam kayıt sayısında eq kesin toplamı, gte alt sınırı, unknown veya null güvenilir toplamın bulunmadığını belirtir. Bunlar sayfa sayısı değildir. Kesin toplam bile istemcinizin her kaydı kaydettiğini kanıtlamaz. Yanıtlar düzdür; okumak veya saymak için ağaç kurmanız gerekmez. İlişki incelemesi yapacaksanız yalnızca mevcut parent_id veya link_id ile isteğe bağlı yerel gruplama yapabilirsiniz. Eksik üst kayıtlar geri getirilemez.
Node.js hata akışı ve kredi ayrımı
HTTP 400 parametre biçimini veya değerini, HTTP 401 eksik ya da geçersiz anahtarı, HTTP 402 yetersiz bakiyeyi, HTTP 429 hız sınırını belirtir. Node.js fetch çağrısında bu HTTP yanıtlarını ağ bağlantısı hatasından ayırın. response.ok değerini incelemeden içerik okumayı iş başarısı saymayın. Parametre veya anahtar hatasını aynı istekle tekrarlamak yerine düzeltin; hız sınırında gönderimi erteleyin.
Başarılı veri alma, boş sonuçta da bir kredi kullanır. Geçersiz istekten kredi düşülmez; üst kaynak hatasında ayrılan kredi geri verilir. İstemcide zaman aşımı veya bağlantı kaybı ise sunucudaki ücretli başarıyı gizleyebilir. Başarılı tekrar yeni bir kredi harcar. Gizli başlıkları yazdırmadan HTTP durumunu ve kendi iş kimliğinizi kaydetmek, yeniden deneme kararını değerlendirmeye yardımcı olabilir.