Lewati ke konten utama

Referensi Endpoint

Bagian ini mendokumentasikan semua endpoint REST yang disediakan oleh API ChurchApps. Setiap halaman modul mencantumkan setiap rute beserta metode HTTP, path, persyaratan autentikasi, dan izin yang diperlukan.

URL Dasar​

LingkunganURL
Pengembangan lokalhttp://localhost:8084
Produksihttps://api.churchapps.org

Konvensi Permintaan​

  • Content-Type: Semua badan permintaan dan respons menggunakan application/json
  • Multi-tenant: Setiap permintaan yang terautentikasi dibatasi ke churchId yang diambil dari token JWT — Anda tidak perlu menyertakan churchId di URL
  • Penyimpanan batch: Sebagian besar endpoint POST menerima array objek. API akan menambahkan rekaman baru (tanpa field id) dan memperbarui rekaman yang sudah ada (dengan field id) dalam satu panggilan
  • ID: Semua ID entitas berupa UUID

Contoh: Penyimpanan Batch​

POST /membership/people
Authorization: Bearer <token>

[
{ "firstName": "Jane", "lastName": "Doe" },
{ "id": "abc-123", "firstName": "John", "lastName": "Smith" }
]

Objek pertama akan dibuat (baru); objek kedua akan diperbarui (memiliki id).

Format Respons​

Respons yang berhasil mengembalikan JSON, berupa satu objek atau array. Respons kesalahan menggunakan kode status HTTP standar:

KodeArti
200Berhasil
400Permintaan tidak valid (kesalahan validasi)
401Tidak diizinkan (token hilang/tidak valid atau izin tidak mencukupi)
404Tidak ditemukan
500Kesalahan server

Kesalahan validasi dikembalikan dalam bentuk:

{
"errors": [
{ "msg": "enter a valid email address", "param": "email", "location": "body" }
]
}

Cara Membaca Tabel Endpoint​

Setiap halaman modul mengelompokkan endpoint berdasarkan controller. Tabel menggunakan kolom-kolom berikut:

KolomKeterangan
MethodMetode HTTP (GET, POST, DELETE)
PathPath rute relatif terhadap base path controller
AuthJWT = memerlukan Bearer token, Public = tidak memerlukan autentikasi
PermissionIzin yang diperlukan (misalnya People.Edit). — berarti semua pengguna yang terautentikasi
DescriptionFungsi endpoint

Controller yang memperluas kelas dasar CRUD standar secara otomatis menyediakan empat endpoint: GET / (daftar semua), GET /:id (ambil berdasarkan ID), POST / (buat/perbarui), dan DELETE /:id (hapus).

Modul Pelaporan​

Modul Pelaporan bekerja berbeda dari modul lainnya. Alih-alih CRUD berbasis database, modul ini memuat definisi laporan dari file JSON di disk dan menjalankan kueri SQL berparameter.

MethodPathAuthDescription
GET/reporting/reports/:keyNameJWTMuat definisi laporan berdasarkan nama kunci
GET/reporting/reports/:keyName/runJWTJalankan laporan dan kembalikan hasilnya

Parameter laporan diteruskan sebagai nilai query string (misalnya ?startDate=2024-01-01&endDate=2024-12-31). Parameter churchId disisipkan secara otomatis dari token JWT. Setiap definisi laporan dapat menentukan persyaratan izinnya sendiri.

Indeks Modul​

ModulBase PathKeterangan
Autentikasi/membership/users, /membership/oauthLogin, pendaftaran, token JWT, OAuth, izin
Keanggotaan/membership/*Orang, gereja, grup, rumah tangga, peran, formulir, pengaturan
Kehadiran/attendance/*Kampus, layanan, sesi, kunjungan, catatan check-in
Konten/content/*Halaman, khotbah, acara, berkas, galeri, Alkitab, streaming
Persembahan/giving/*Donasi, dana, gerbang pembayaran, langganan
Pesan/messaging/*Percakapan, notifikasi, perangkat, SMS
Doing/doing/*Rencana, tugas, penugasan, otomasi, penjadwalan