Bawwabah بوابة|API Fajwah

Pasang mesin Fajwahdi sistem Anda sendiri.

“Satu kunci API, bukti per paper ikut terbawa.”

Untuk kampus, LPPM, perpustakaan, penerbit jurnal, dan platform riset. Verifikasi status Scopus dari data resmi SCImago, atau susun laporan research gap berbukti langsung dari repositori, sistem pengajuan proposal, atau aplikasi Anda. Dibayar dengan kredit, tanpa berlangganan per pengguna.

API REST + JSONWebhook bertanda tanganKredit kembali bila gagal
Fitur

Dua layanan inti, dibuka bertahap.

Endpoint yang dibuka dipilih yang memperkuat integritas riset. Parafrase dan penyuntingan sengaja tidak tersedia lewat API agar tidak dipakai untuk produksi tulisan massal.

sjrVerifikasi jurnal

Cocokkan nama atau ISSN jurnal dengan data resmi SCImago: terindeks atau tidak, kuartil, skor SJR, bidang.

reportsLaporan gap

Topik masuk, laporan keluar: peta literatur, matriks, gap, novelty, teori, ide, metode, dan status Scopus tiap paper.

webhookHasil dikirim otomatis

Laporan berjalan di latar. Hasilnya dikirim ke server Anda dengan tanda tangan HMAC, atau ambil lewat polling.

kreditBayar sesuai pakai

Saldo kredit per kunci. Laporan yang gagal tidak dipotong. Pemakaian bisa dipantau lewat /v1/me.

Kredit

Harga per panggilan, transparan.

Kredit dibeli per paket lewat invoice atau QRIS. Paket institusi dan harga volume bisa dibicarakan.

EndpointKredit

Dokumentasi

Referensi API v1.

Mulai cepat

  1. Minta kunci API ke admin Fajwah. Anda menerima api_key (berawalan fjk_live_) dan webhook_secret. Keduanya hanya ditampilkan sekali.
  2. Simpan kunci di server Anda. Jangan menaruhnya di kode browser atau aplikasi seluler.
  3. Coba panggilan pertama:
curl https://fajwah.mshadianto.id/v1/me \
  -H "Authorization: Bearer $FAJWAH_API_KEY"

Alamat dasar: https://fajwah.mshadianto.id. Semua permintaan dan jawaban berformat JSON (UTF-8).

Autentikasi

Kirim kunci di header Authorization: Bearer fjk_live_… atau X-API-Key: fjk_live_…. Setiap kunci punya cakupan (sjr, reports), saldo kredit, dan batas permintaan per menit. Kunci yang bocor bisa diganti admin kapan saja; kunci lama langsung tidak berlaku.

Endpoint

Informasi kunci dan saldo

GET/v1/me0 kredit

Nama, organisasi, cakupan, saldo kredit, batas per menit, dan pemakaian bulan ini.

{
  "key_id": "k_3f9a1c2e", "name": "LPPM Universitas X", "scopes": ["sjr", "reports"],
  "credits": 480, "rate_per_min": 60,
  "usage_this_month": { "requests": 12, "credits": 120 }
}

Verifikasi jurnal

POST/v1/sjr/lookup1 kredit per 10 jurnal

Maksimal 200 jurnal per panggilan. ISSN dipakai lebih dulu; bila tidak ada, dicocokkan lewat nama. Jurnal yang tidak ditemukan di data SCImago bernilai match: null, tidak dikira-kira.

FieldKeterangan
journals[].nameNama jurnal (wajib)
journals[].issnDaftar ISSN cetak/daring (opsional, disarankan)


        

Susun laporan gap

POST/v1/reports20 · 30 · 40 kredit

Laporan disusun di latar, sekitar 1–3 menit. Jawaban langsung berstatus 202 dengan id. Ambil hasilnya lewat polling atau tunggu webhook. Bila proses gagal, kredit dikembalikan otomatis.

FieldKeterangan
topicTopik, judul, atau gagasan riset (3–400 karakter, wajib)
year_from, year_toRentang tahun publikasi (bawaan 2015–2026)
fieldBidang ilmu (bawaan "Ekonomi & Keuangan Syariah")
papersJumlah paper dibaca, 10–50 (bawaan 30). ≤20: 20 kredit, ≤35: 30 kredit, ≤50: 40 kredit
languageid atau en, bahasa isi laporan
webhook_urlOpsional. Alamat https publik untuk menerima hasil
referenceOpsional. ID dari sistem Anda, dikembalikan apa adanya


        

Ambil status dan hasil laporan

GET/v1/reports/{id}0 kredit

status bernilai running, done, atau error. Saat done, field report berisi laporan lengkap: meta, papers (judul, tahun, jurnal, DOI, teori, metode, sampel, temuan, keterbatasan, status SJR), dan synth (klaster, ringkasan, gap, novelty, teori, ide, metode, dengan rujukan P1, P2, …). report_url membuka laporan yang sama di Fajwah. Polling cukup tiap 5–10 detik.

{
  "id": "a1b2c3d4e5f6", "status": "done", "reference": "proposal-2026-118", "credits": 30,
  "report_url": "https://fajwah.mshadianto.id/app?r=a1b2c3d4e5f6",
  "report": {
    "meta": { "topic": "Islamic fintech adoption", "range": "2018–2026", "sjr_label": "…" },
    "papers": [ { "id": "P1", "title": "…", "journal": "…", "doi": "…", "method": "…", "finding": "…", "sjr": { "quartile": "Q2" } } ],
    "synth": { "summary": ["…"], "gaps": { "rare": [ { "text": "…", "refs": ["P3"] } ] }, "novelty": [ … ] }
  }
}

Webhook

Bila webhook_url diisi, Fajwah mengirim POST JSON setelah laporan selesai atau gagal, dengan event report.completed atau report.failed. Isi data sama dengan jawaban GET /v1/reports/{id}. Pengiriman diulang hingga 3 kali bila server Anda tidak menjawab 2xx.

Verifikasi setiap kiriman: hitung HMAC-SHA256 dengan webhook_secret atas teks "<X-Bawwabah-Timestamp>.<body mentah>", lalu bandingkan dengan header X-Bawwabah-Signature (format sha256=<hex>). Tolak kiriman yang timestamp-nya lebih tua dari 5 menit.



        

Kode galat

Galat dikembalikan sebagai {"detail": {"code": "…", "message": "…"}}.

HTTP · codeArti
401 missing_key / invalid_keyKunci tidak dikirim atau tidak dikenal
403 key_disabled / scope_deniedKunci dinonaktifkan, atau tidak punya akses ke endpoint ini
402 insufficient_creditsSaldo kredit tidak cukup
400 invalid_webhookwebhook_url bukan alamat https publik
422Isian tidak valid (lihat detail field)
429 rate_limited / too_many_runningMelebihi batas per menit, atau terlalu banyak laporan berjalan
503 busy / sjr_unavailableLayanan sementara penuh; coba lagi

Batas pemakaian

  • Bawaan 60 permintaan per menit per kunci, dan maksimal 3 laporan berjalan bersamaan. Bisa dinaikkan untuk paket institusi.
  • Hasil laporan bisa diambil kapan saja lewat GET /v1/reports/{id}; status proses yang sedang berjalan disimpan selama server tidak dimulai ulang.
  • Naskah dan data yang Anda kirim hanya dipakai untuk memproses permintaan.

Integritas

Bawwabah membantu menemukan dan memverifikasi literatur. Laporan adalah titik awal yang harus diperiksa peneliti: baca paper aslinya sebelum mengutip. Layanan parafrase dan penyuntingan tidak dibuka lewat API. Pelanggaran ketentuan dapat membuat kunci dinonaktifkan.

Pertanyaan teknis, paket institusi, atau permintaan cakupan baru: hubungi admin lewat WhatsApp atau khadam.digital@mshadianto.id.