Pusat Dokumentasi Developer & API REST API V1 Ready

Dokumentasi Sistem & REST API Mobile

Panduan integrasi REST API Android / Mobile Client, download Postman Collection v2.1, serta dokumentasi baku komponen antarmuka web sistem UPAB Pesantren Ulul Albab Cabang 3.

Postman Collection v2.1.0

Koleksi endpoint terstruktur terpisah 5 folder per-role lengkap dengan header, variable, body schema, dan contoh respons JSON.

Download Collection (.json) Raw JSON URL

Import Langsung via Link di Postman:

https://www.ula-water.epraja.net/api/v1/postman-collection

Base URL Endpoint

https://www.ula-water.epraja.net/api/v1

Seluruh endpoint REST API menggunakan awalan /api/v1/.

Metode Autentikasi

Bearer Token (Laravel Sanctum)

Gunakan header Authorization: Bearer {token} pada endpoint yang diproteksi.

Daftar Lengkap Endpoint REST API Per Role

Telah terorganisir rapi dalam 5 folder terpisah untuk mempermudah integrasi aplikasi mobile Android/iOS.

44+ Endpoints Ready (CRUD Pelanggan)

FOLDER 1

Autentikasi & Akun Profil (Semua Role)

POST /api/v1/auth/login Publik

POST /api/v1/auth/activate Publik

Aktivasi akun mandiri untuk warga yang sudah terdaftar di data pengelola.

POST /api/v1/auth/register Publik

Pendaftaran permohonan pasang baru mandiri oleh warga komplek.

GET /api/v1/auth/me PUT /api/v1/auth/profile PUT /api/v1/auth/password Bearer Auth

Ambil profil login, update identitas diri, dan ganti kata sandi.

FOLDER 2

Role: Pengguna (Warga / Konsumen Air)

GET /api/v1/customer/dashboard Bearer Auth

Dashboard ringkasan tagihan aktif bulan berjalan, mutu WTP, dan status akun.

GET /api/v1/customer/bills GET /api/v1/customer/bills/{id} POST /api/v1/customer/bills/{id}/pay Multipart Form

Daftar tagihan, detail breakdown tarif (Rp 500 rounding), dan upload foto bukti transfer bank.

GET /api/v1/customer/meter/current-period POST /api/v1/customer/meter/record GET /api/v1/customer/meter/history

Catat meter mandiri warga + upload foto stand meter fisik dari kamera HP.

GET /api/v1/customer/complaints POST /api/v1/customer/complaints

Laporan gangguan (pipa bocor, air keruh) + foto bukti & tracking respon TRC.

FOLDER 3

Role: Petugas Lapangan & Catat Meter (Merangkap Kasir / Admin)

GET /api/v1/officer/dashboard Bearer Auth

Statistik progres pencatatan keseluruhan & persentase tiap zonasi wilayah.

GET /api/v1/officer/customers Filter Ready

Filter pelanggan belum tercatat (status_filter=unrecorded), zonasi & pencarian.

GET /api/v1/officer/customers/{id}/meter POST /api/v1/officer/meters/record GET /api/v1/officer/meters/history

Cek meter awal, input stand meter lapangan (+ foto), dan riwayat pembacaan meter pelanggan.

GET /api/v1/officer/bills GET /api/v1/officer/bills/{id} POST /api/v1/officer/bills/{id}/pay

Daftar tagihan rekening warga, rincian kuitansi, dan pelunasan kasir langsung di lapangan (Tunai / QRIS / TF).

GET /api/v1/officer/complaints POST /api/v1/officer/complaints PUT /api/v1/officer/complaints/{id}/status

Daftar tiket keluhan warga, lapor temuan lapangan baru, dan update status/penyelesaian oleh tim teknis.

FOLDER 4

Role: Admin Kasir (Loket Pembayaran & Keuangan)

GET /api/v1/cashier/dashboard GET /api/v1/cashier/bills Bearer Auth

Dashboard penerimaan kasir hari ini & pencarian tagihan warga (nama/nomor pelanggan).

POST /api/v1/cashier/bills/{id}/pay GET /api/v1/cashier/transactions

Pelunasan loket (Tunai/QRIS/TF), cetak kode TRX-KASIR, hitung kembalian, dan rekap kas.

FOLDER 5

Master Data & Utilitas (CRUD Lengkap)

CRUD Pelanggan Ready

GET /api/v1/customers GET /api/v1/customers/{id} Search & Filter

List data pelanggan (status, zone_id, category_id, search, sort) & detail profil via ULID/no. pelanggan/meter.

GET /api/v1/customers/generate-number POST /api/v1/customers Auto User Login

Generate otomatis no pelanggan & meter, serta tambah master pelanggan baru + akun login aplikasi mobile.

PUT /api/v1/customers/{id} DELETE /api/v1/customers/{id} Soft Delete Guard

Update identitas pelanggan & sinkronisasi user, serta hapus pelanggan dengan proteksi tagihan aktif.

GET /api/v1/zones GET /api/v1/categories POST /api/v1/tariffs/calculate

Daftar zonasi, kategori tarif progresif, dan simulasi tarif kubikasi pembulatan Rp 500 (round_up_500).

GET /api/v1/water-status GET /api/v1/settings/payment

Status pasokan air & mutu laboratorium WTP real-time, serta rekening bank resmi & metode pembayaran.

Standar Komponen UI & Form Playground

Pengujian langsung interaktivitas form, datatable, searchable select, flatpickr, dan filepond.

Komponen Dasar

Form Input, Textarea & Button States

Pondasi input form untuk data sambungan, angka meteran, validasi error, clearable button, dan character count.

Nomor Sambungan Pelanggan (ID Pelanggan)

Format standar 13 digit nomor kontrak sambungan.

Nomor Seri Meteran Air (Error State Demo)

Nomor seri meteran ini telah terdaftar pada pelanggan lain.

Stand Meter Awal (m³)

Angka meteran periode sebelumnya.

Stand Meter Akhir (m³)

Angka meteran fisik terbaru di lapangan.

Catatan Kondisi Fisik & Pemeriksaan Meteran

Maksimal 500 karakter dengan indikator penghitung dinamis.

Dokumentasi Galeri Teknis WTP & Jaringan Pipa

Arsip foto fasilitas pengolahan air bersih, reservoir, pompa distribusi, dan jaringan pipa komplek.

WTP & Pabrik Air

Instalasi Pengolahan Air (WTP & Clarifier)

Unit sedimentasi, koagulasi, dan filtrasi air baku berkapasitas 500 liter/detik dengan standar baku mutu.

Aug 2025

Infrastruktur Pipa

Stasiun Pompa Intake & Pipa Distribusi

Stasiun pompa penyedot air baku dan jaringan valve manifold untuk distribusi ke komplek & kawasan industri.

Sep 2025

Laboratorium & Mutu

Laboratorium Uji Kualitas TDS & Mikrobiologi

Pengujian harian parameter fisik, kimiawi, TDS, pH, dan mikrobiologis sesuai standar Permenkes RI.

Oct 2025

SCADA & Otomasi

Pusat Kontrol SCADA & Telemetri Debit Air

Pemantauan tekanan pipa transmisi, sensor debit air, dan deteksi anomali kebocoran pipa (NRW) real-time.

Nov 2025

Infrastruktur Pipa

Reservoir Gravitasi Penampung Air Bersih

Tangki penampung air bersih berkapasitas 5.000 m³ dengan sistem sirkulasi untuk suplai elevasi tinggi.

Dec 2025

WTP & Pabrik Air

Instalasi Pompa Booster & Filtrasi Food Grade

Sistem pompa bertekanan tinggi dengan perpipaan stainless steel sanitari untuk pengolahan air minum pabrik.

Jan 2026

Komponen Baku Notifikasi

Notifikasi Modern SweetAlert2

Standar notifikasi popup toast & dialog konfirmasi interaktif untuk seluruh aksi CRUD dan validasi.

Toast Sukses

Notifikasi pojok kanan atas setelah simpan/update berhasil.

Toast Error

Peringatan kegagalan proses atau kesalahan sistem.

Toast Peringatan

Pemberitahuan anomali atau data di luar batas normal.

Modal Dialog

Popup modal dialog informatif di tengah layar.

Komponen Dialog Konfirmasi Interaktif (SweetAlert 2)

Mencegah kesalahan pengguna sebelum menjalankan perintah kritis (Hapus, Simpan, Ubah, dll.) tanpa menggunakan dialog browser bawaan.

1. Konfirmasi Hapus Data

Tema bahaya dengan tombol hapus merah & fokus otomatis ke batal.

2. Konfirmasi Simpan Data

Tema pertanyaan dengan tombol simpan biru toska & icon question.

3. Konfirmasi Ubah Data

Verifikasi pembaruan setting atau tarif air sebelum diterapkan.

4. Prompt Verifikasi Teks

Meminta pengguna mengetikkan kata kunci khusus untuk aksi risiko tinggi.

Cara Menggunakan Konfirmasi SweetAlert 2 di View / Livewire:

// 1. Langsung pada tombol / link Livewire:

<button wire:click="delete('$id')" wire:confirm="Hapus data pelanggan ini?">Hapus</button>

<button wire:click="save" wire:confirm="Simpan data formulir ini?">Simpan</button>

// 2. Konfirmasi dengan pengetikan kata kunci (wire:confirm.prompt):

<button wire:click="resetData" wire:confirm.prompt="Ketik HAPUS untuk konfirmasi|HAPUS">Reset</button>

// 3. Menggunakan Blade Component:

<x-ui.confirm-alert title="Hapus Data" text="Apakah Anda yakin?" action="deleteItem">

<button @click="confirmAction()">Hapus</button>

</x-ui.confirm-alert>

Dokumentasi Sistem & REST API Postman