Status publik dan rute data
Alamat dasar adalah https://api.redditgateway.com. GET /v1/status tidak memakai kunci atau kredit. Respons menunjukkan cakupan layanan tetap serta aplikasi HTTP yang merespons. Sumber arsip, pencarian, catatan, dan saldo tidak diperiksa. Jangan menampilkan rute ini sebagai pemeriksaan pencarian. Permintaan data setelahnya tetap mempunyai autentikasi, batas, serta penanganan kesalahan sendiri dan perlu diperiksa secara terpisah.
GET /v1/search mencari posting dan komentar; /v1/posts mengambil posting, sedangkan /v1/comments mengambil komentar. GET /v1/item?id=... meminta satu catatan menurut pengenalnya. id hanya untuk item, bukan filter posts atau comments. GET /v1/subreddits?prefix=... mencari awalan nama komunitas. limit dapat membatasi jumlah yang diminta. Hitungan dalam agregasi komunitas tidak dijamin tepat untuk seluruh arsip, sehingga jangan menafsirkannya sebagai inventaris lengkap.
Pengambilan terlindungi menerima Authorization: Bearer YOUR_API_KEY dan X-API-Key: YOUR_API_KEY. Pilih satu header dan kirim kunci asli hanya dari server. Cookie Secure HttpOnly pada panel akun mengelola sesi berbeda, bukan pengganti kunci API. Kunci, akun, dan saldo khusus domain ini. Gunakan konfigurasi rahasia server, bukan parameter URL atau kode yang dikirim ke browser. Status publik juga tidak menguji validitas kunci tersebut.
Filter, halaman, dan batas hasil
Pencarian, posting, dan komentar mendukung q, subreddit, author, kind, from, to, min_score, limit, serta page. Nilai kind adalah post atau comment. Tanggal memakai YYYY-MM-DD berdasarkan UTC; hari to termasuk dalam rentang. min_score adalah skor minimum, bukan pengurutan. parent_id dan link_id bukan filter kueri. Mengirim bidang hubungan itu tidak membuat permintaan untuk memperoleh seluruh percakapan atau semua catatan induk yang terkait.
limit menerima 1–100 dan page menerima 1–100. Batasnya 100 catatan per permintaan serta 100 halaman per kueri, dengan setiap halaman diminta tersendiri. Hasil mengikuti urutan dokumen arsip, bukan waktu, relevansi, atau skor. Pengulangan halaman dan pembagian tanggal tidak menjamin hasil lengkap maupun unik. Catat kondisi serta halaman yang tersimpan dalam aplikasi agar cakupan yang benar-benar diterima dapat dijelaskan.
Total catatan dengan eq bersifat tepat, gte adalah batas bawah, dan unknown atau null berarti tidak ada total andal. Total bukan jumlah halaman dan angka tepat tidak membuktikan klien telah menyimpan semua hasil. Respons berupa catatan datar. Membaca atau menghitung tidak memerlukan pohon. Jika meneliti hubungan, pengelompokan lokal dengan parent_id atau link_id yang tersedia bersifat pilihan dan tidak memulihkan induk yang hilang.
Kesalahan dan pengelolaan kunci
HTTP 400 menunjukkan format atau nilai parameter tidak valid; HTTP 401 kunci hilang atau tidak valid, HTTP 402 saldo kurang, dan HTTP 429 batas laju. 429 bukan waktu tunggu koneksi yang habis. Perbaiki parameter dan kunci, serta tunda pengiriman ketika terkena batas laju. Pengambilan berhasil, termasuk kosong, memakai satu kredit. Permintaan tidak valid tidak mendebit; kegagalan sumber hulu mengembalikan cadangan kredit.
Kunci API ditampilkan tepat setelah pendaftaran dan hanya dapat dilihat satu kali segera setelah proses pembuatan akun selesai. Anda dapat melakukan regenerasi kunci API secara aman setelah mengonfirmasi kata sandi, namun regenerasi akan langsung membuat kunci lama tidak berlaku. Proses ini tidak memerlukan fitur pemulihan kata sandi atau pengiriman email otomatis untuk pengiriman kunci.
Koneksi yang terputus di klien tidak membuktikan server belum berhasil menjalankan permintaan berbayar. Pengulangan berhasil menggunakan kredit lagi. Pisahkan kegagalan jaringan dari respons HTTP dan catat pekerjaan yang sudah disimpan tanpa menulis header rahasia. Kunci ditampilkan sekali saat pendaftaran sebelum pembayaran, bukan ditampilkan ulang pada setiap login. Jika diregenerasi, perbarui konfigurasi aplikasi yang masih memakai nilai sebelumnya.
