Skip to content

Implementasi API Al-Quran berbasis Google Apps Script yang menggunakan Google Spreadsheet sebagai database. Menyediakan akses ke teks Al-Quran, terjemahan, audio, dan fitur pencarian melalui REST API

Notifications You must be signed in to change notification settings

classyid/QuranGSheet-API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

3 Commits
Β 
Β 
Β 
Β 

Repository files navigation

QuranGSheet-API

API Al-Quran berbasis Google Apps Script dengan Google Spreadsheet sebagai database.

πŸ“– Tentang Proyek

QuranGSheet-API adalah solusi ringan untuk menyediakan akses terhadap data Al-Quran melalui REST API. Proyek ini memanfaatkan kekuatan Google Apps Script dan Google Spreadsheet sebagai database, menjadikannya solusi yang mudah di-deploy dan dikelola tanpa memerlukan infrastruktur server yang kompleks.

Fitur Utama

  • βœ… Akses lengkap ke 114 surah Al-Quran
  • βœ… Dukungan teks Arab, Latin, dan terjemahan
  • βœ… Pencarian kata kunci dalam Al-Quran
  • βœ… Akses berdasarkan juz dan halaman
  • βœ… Dukungan URL audio untuk setiap ayat
  • βœ… Sistem caching untuk performa optimal
  • βœ… Analytics untuk melihat penggunaan API

πŸš€ Cara Menggunakan

Endpoint API

  1. Daftar Semua Surah

    ?action=getAllSurah
    
  2. Mendapatkan Satu Surah

    ?action=getSurah&number=1
    
  3. Mendapatkan Satu Ayat

    ?action=getAyat&surah=1&ayat=1
    
  4. Pencarian Kata Kunci

    ?action=search&q=keyword
    
  5. Mendapatkan Ayat dalam Juz

    ?action=getJuz&number=1
    
  6. Mendapatkan Ayat dalam Halaman

    ?action=getPage&number=1
    
  7. Mendapatkan URL Audio

    ?action=getAudio&surah=1&ayat=1&qari=default
    

Contoh Respons

{
  "status": "success",
  "data": {
    "surah": {
      "number": 1,
      "name": "Al-Fatihah",
      "name_latin": "Al-Fatihah",
      "number_of_ayah": 7,
      "revelation_type": "Makkiyah"
    },
    "ayat": [
      {
        "number": 1,
        "text": "بِسْمِ Ψ§Ω„Ω„ΩŽΩ‘Ω‡Ω Ψ§Ω„Ψ±ΩŽΩ‘Ψ­Ω’Ω…ΩŽΩ°Ω†Ω Ψ§Ω„Ψ±ΩŽΩ‘Ψ­ΩΩŠΩ…Ω",
        "translation": "Dengan nama Allah Yang Maha Pengasih, Maha Penyayang."
      },
      // ... ayat lainnya
    ]
  }
}

πŸ› οΈ Cara Deploy

  1. Buat Google Spreadsheet baru
  2. Buat dua sheet: surahQuran dan ayatQuran
  3. Impor data surah dan ayat sesuai struktur
  4. Buka Google Apps Script dari menu Ekstensi
  5. Salin kode dari main.gs ke editor script
  6. Ganti SPREADSHEET_ID dengan ID Spreadsheet Anda
  7. Deploy sebagai Web App
  8. Tetapkan akses ke "Anyone, even anonymous"

πŸ“Š Struktur Data

Sheet surahQuran

  • number
  • name
  • name_latin
  • number_of_ayah
  • revelation_type
  • ...

Sheet ayatQuran

  • surah
  • number
  • text
  • latin
  • translation
  • juz
  • page
  • audio
  • ...

πŸ”’ Keamanan

API ini dilengkapi dengan sistem otentikasi sederhana untuk akses admin ke data analytics. Gunakan parameter key dengan nilai yang telah ditentukan untuk mengakses endpoint getAnalytics.

πŸ“ Lisensi

Proyek ini tersedia di bawah lisensi MIT. Silakan lihat file LICENSE untuk detailnya.

✨ Kontribusi

Kontribusi selalu diterima! Silakan ajukan pull request atau buka issue untuk melaporkan bug atau meminta fitur baru.

πŸ“ž Kontak

Jika ada pertanyaan, silakan hubungi saya melalui [email] atau buka issue di repository ini.


Dibuat dengan ❀️ untuk memudahkan akses terhadap Al-Quran

About

Implementasi API Al-Quran berbasis Google Apps Script yang menggunakan Google Spreadsheet sebagai database. Menyediakan akses ke teks Al-Quran, terjemahan, audio, dan fitur pencarian melalui REST API

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published