Kamuya açık durum ve veri yolları
Temel adres https://api.redditgateway.com üzerindedir. GET /v1/status anahtarsız ve ücretsizdir. Sabit hizmet kapsamını ve HTTP uygulamasının yanıt verdiğini gösterir. Arşiv kaynağını, aramanın çalışmasını, kayıtların varlığını veya bakiyeyi kontrol etmez. Bu yolu bir arama denetimi olarak sunmayın. Durum yanıtından sonra gönderilen veri isteği kendi kimlik doğrulamasına, sınırlarına ve hata işleyişine tabidir.
GET /v1/search gönderi ve yorum arar; /v1/posts gönderileri, /v1/comments yorumları getirir. GET /v1/item?id=... tek kaydı kimliğiyle ister. id yalnızca item yolunda desteklenir, posts ve comments filtresi değildir. GET /v1/subreddits?prefix=... topluluk adının başlangıcıyla sorgu yapar. limit ile istenen sonuç sayısını belirleyebilirsiniz. Topluluk özetlerindeki sayımların bütün arşiv için kesin olduğu garanti edilmez.
Korumalı veri istekleri Authorization: Bearer YOUR_API_KEY ve X-API-Key: YOUR_API_KEY seçeneklerinin ikisini de kabul eder. Birini seçip gerçek anahtarı yalnızca sunucudan gönderin. Hesap panelinin Secure HttpOnly çerezi başka bir oturumu yönetir ve API anahtarı yerine geçmez. Anahtar ve bakiye bu alana özgüdür. URL’ye anahtar eklemek veya tarayıcı koduna gömmek yerine sunucunuzun gizli yapılandırmasını kullanın.
Filtreler, sayfalar ve sonuçların sınırı
Arama, gönderi ve yorum yolları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çimindedir; to belirtilen günün tamamını kapsar. min_score alt puan sınırıdır, sıralama değildir. parent_id ve link_id sorgu filtreleri değildir. Mevcut ilişki alanlarını göndererek tüm konuşmayı isteme işlevi 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 vardır. Her sayfa ayrı bir istektir. Arşiv belge sırası tarih, ilgi veya puan sırası değildir. Sayfa döngüsü ve tarih dilimleri eksiksiz ya da tekrarsız toplamayı garanti etmez. Hangi koşul ve sayfaları kaydettiğinizi kendi iş kayıtlarınızda takip edin.
Toplam kayıt sayısında eq kesin değeri, gte alt sınırı, unknown veya null güvenilir toplamın bulunmadığını gösterir. Toplam sayfa sayısı değildir. Kesin toplam da istemcinizin her kaydı sakladığını kanıtlamaz. Yanıtlar düz kayıtlardır; okumak veya saymak için ağaç gerekmez. İlişkiler için mevcut parent_id veya link_id ile isteğe bağlı yerel gruplama yapabilirsiniz. Bu işlem eksik üst kayıtları ve yorumları geri getirmez.
Hata ve anahtar yönetimi
HTTP 400 parametre biçimi veya değerini, HTTP 401 eksik veya geçersiz anahtarı, HTTP 402 yetersiz bakiyeyi, HTTP 429 hız sınırını belirtir. 429 zaman aşımı değildir. Parametre ve anahtar hatasını düzeltin; hız sınırında yeni gönderimi erteleyin. Başarılı boş yanıt da bir kredi harcar. Geçersiz istekten kredi düşülmez; üst kaynak hatasında ayrılan kredi geri verilir.
Anahtar yönetimi, kullanıcı paneli üzerinden de gerçekleştirilebilir. Oturum açmış kullanıcılar, parolalarını doğrulayarak API anahtarlarını yeniden oluşturabilirler. Bu işlem, eski anahtarı hemen geçersiz kılar ve yeni bir anahtar oluşturur. Parola sıfırlama veya e-posta ile anahtar gönderme gibi ek özellikler mevcut değildir. Doğrudan istemci paneli üzerinden güvenli bir şekilde yenileme işlemi yapılır.
Bağlantı kopması nedeniyle istemcide hata görünmesi, sunucuda ücretli başarı oluşmadığını kanıtlamaz. Başarılı tekrar ayrıca ücretlidir. Ağ ve HTTP hatalarını ayrı ele alın; gizli başlıkları yazmadan kendi iş kimliğinizle hangi yanıtın kaydedildiğini izleyin. Anahtar kayıt anında ödeme öncesinde bir kez gösterilir. Sonraki giriş eski değeri yeniden sunmaz; yeni anahtar üretirseniz uygulamanızdaki gizli yapılandırmayı da güncellemeniz gerekir.
