Kimlik doğrulama ve yollar
İçerik okumak için GET isteğinize Authorization: Bearer <key> veya X-API-Key: <key> ekleyin. İkisi desteklenen alternatiflerdir. Anahtar redditlistening.com hesabına aittir; başka alan adının anahtarı bu hesabın yerine geçmez. Hesap panelinin Secure HttpOnly oturum çerezi ayrı bir mekanizmadır ve veri sorgusundaki API anahtarının yerine kullanılmaz.
/v1/search metin arar; /v1/posts ve /v1/comments ilgili kayıt türünü sınırlar. Bu üç yol q, subreddit, author, kind, from, to, min_score, limit ve page parametrelerini kabul eder. kind değerleri post ve comment’tir. /v1/posts ve /v1/comments için id gerekmez. Tek bir kayıt aramak için /v1/item?id=... kullanın; bu yolun parametresi id’dir.
/v1/subreddits yalnızca prefix ve limit kabul eder; içerik araması veya tarih filtreli konuşma taraması değildir. Buradaki sayımlar küresel ölçekte kesin topluluk büyüklüğünü göstermez. /v1/status herkese açıktır ve ücretsizdir. Sabit hizmet açıklamasıyla HTTP sunucusunun yanıt verdiğini gösterir; arama altyapısının sağlığını, kayıt bulunacağını veya arşivin erişilebilirliğini doğrulamaz.
Tarih, sıra ve yanıtı yorumlama
from ve to değerlerini YYYY-MM-DD biçiminde UTC günleri olarak gönderin. Filtrelenen alan created_utc’dir. to belirtilen günün tamamını kapsar; bugün için UTC tarihini yazarsanız bugünün tamamı dahildir, yalnızca gece yarısı değil. Bu filtre kayıtların oluşturulma zamanına uygulanır; çantanın satın alınma veya kullanılan ürünün piyasaya çıkış tarihi anlamına gelmez.
İçerik sorgusunda limit 1–100, page 1–100 aralığındadır. Sonuçlar arşivin _doc sırasındadır; kronolojik, ilgililik veya puan sıralaması değildir. min_score yalnızca alt puan eşiğini uygular. En yüksek puanlı yorumları ilk sayfada beklemeyin. Yerel sıralama yalnızca indirdiğiniz kayıtları düzenler; henüz alınmamış kayıtlar hakkında yeni bir bilgi sağlamaz.
Yanıtlar düz kayıtlardır, sunucuda birleştirilmiş konuşma ağaçları değildir. parent_id veya link_id mevcutsa yerel ilişkilendirme yapabilirsiniz; bunlar sorgu filtresi değildir. Eksik alanı, null değeri ve boş metni uygulamanızda ayırın. Paginasyon toplamında eq kesin sayı, gte alt sınır, unknown güvenilir toplam bulunmadığı anlamına gelir; toplam null olabilir. Hiçbiri arşiv kapsamının kanıtı değildir.
Hatalar ve kontrollü araştırma
HTTP 400 geçersiz isteği, 401 eksik veya geçersiz anahtarı, 402 yetersiz krediyi, 429 istek sıklığı sınırını belirtir. 400 durumunda belgelenmeyen parametreleri ve tarih biçimini kontrol edin. 401 için anahtarı, 402 için ilgili alan adının bakiyesini inceleyin. 429 sonrasında bekleyin; aynı isteği hızla tekrarlamak araştırmaya yeni bir veri güvencesi eklemez.
Geçersiz istekten kredi düşülmez; kaynak sistem hatasında ayrılan kredi iade edilir. Boş olsa bile başarılı veri alma bir krediye mal olur. Sunucu başarılı işlemi tamamladıktan sonra istemci yanıtı kaybederse bu ücretli başarı olabilir; başarılı tekrar ayrıca ücretlendirilir. Bu nedenle yerel iş günlüğünde sorguyu, deneme zamanını ve gerçekten alınan yanıtı ayrı kaydedin.
BuyItForLife içindeki backpack örneğini önce küçük limit ile inceleyin. Araştırma koşullarını ve dışarıda bıraktığınız kayıtları not edin. Bütün sayfaları istemek veya günlere bölmek eksiksiz, tekil bir veri kümesi garantisi vermez. Aynı kaydı tekrar gördüğünüzde yerel olarak ayırın ve analizinizin sadece gerçekten elde ettiğiniz metinlerle sınırlı olduğunu raporda belirtin.
