dokumentasi / api
API bank soal
rencana Endpoint baca-saja untuk soal TKA dan CPNS. Dirancang agar sekolah dan pengembang bisa memakai bank soal tanpa membangunnya sendiri.
Autentikasi
Setiap permintaan membawa header x-api-key. Kunci dibuat per klien, punya kuota bulanan, dan bisa dicabut tanpa mengganggu klien lain.
curl -H "x-api-key: $BARLVE_KEY" \ "https://api.barlve.com/v1/soal?kategori=BIN&limit=5"
Endpoint yang direncanakan
| Metode | Jalur | Keterangan |
|---|---|---|
| GET | /v1/mapel | Daftar kategori dan jumlah soal aktif |
| GET | /v1/soal | Soal per kategori; parameter kategori, limit, acak |
| GET | /v1/soal/:id | Satu soal beserta pembahasan |
| GET | /v1/kuota | Pemakaian bulan berjalan |
Bentuk respons
{ "data": [ { "id": "...", "kategori": "BIN", "subkategori": "Ide pokok",
"pertanyaan": "...", "pilihan": ["...","..."], "jawaban": 1,
"pembahasan": "..." } ],
"meta": { "total": 30, "kuota": { "terpakai": 12, "batas": 10000 } } }
Batas dan aturan
- Kuota dihitung per request, bukan per soal.
- Dilarang meredistribusikan soal secara utuh; kontrak menyebutkan ini.
- Rate limit 60 request/menit per kunci.
- Kunci disimpan sebagai hash — kunci asli hanya terlihat sekali saat dibuat.