> For the complete documentation index, see [llms.txt](https://serpul.gitbook.io/serpul-app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://serpul.gitbook.io/serpul-app/open-api-serpul/penjelasan-open-api.md).

# Penjelasan Open API

### 💡 Konsep Dasar: Apa sih Open API Serpul itu?

Biar gampang, yuk kita mainin imajinasi bentar.

Bayangin Serpul itu punya "Mesin Pabrik Raksasa" di bawah tanah yang bisa nyiptain pulsa, kuota, token listrik, sampai voucher game secara otomatis.&#x20;

Nah, Open API Serpul ini adalah "Kabel Colokan Panjang" yang diulur dari mesin bawah tanah itu ke permukaan.

Tugas Sobat Serpul tinggal ngambil ujung kabel itu, terus bebas mau dicolokin ke wadah atau bangunan apa aja di atasnya. Mesin pengolah tetep punya Serpul, tapi bentuk bangunannya, bungkus luarnya Sobat Serpul yang tentuin sendiri!

> Poin Penting: Open API bukan aplikasi yang tinggal download di Play Store, melainkan "jalur khusus" biar aplikasi bisa Full custome.

### Bebas Dicolok & Dibikin Jadi Apa Aja?

Karena fungsinya cuma menyuplai data di balik layar (backend), tampilan depannya (frontend) bebas Sobat Serpul bikin pake teknologi apa aja. Kabel Open API ini bisa disulap jadi:

#### 1. Web Apps (Website Jualan)

Bikin website top-up game online atau web jualan PPOB modern dengan desain super clean, minimalis, dan rapi pake brand sendiri.

#### 2. File APK & iOS (Aplikasi HP)

Bikin aplikasi mobile khusus dari nol. Nanti kodingannya bisa dibikin jadi file APK buat Android atau dirilis resmi ke Google Play Store dan App Store.

#### 3. PWA (Progressive Web Apps)

Ini teknologi keren banget! Sobat Serpul bisa bikin website yang punya kemampuan ajaib kayak aplikasi HP.

* User bisa langsung "install" website Sobat Serpul ke layar utama HP mereka tanpa perlu download file gede di Play Store.
* Gak menuh-menuhin memori penyimpanan HP.
* Tetep bisa kirim notifikasi (*push notification*) ke HP pelanggan kayak aplikasi biasa.

#### 4. Desktop Apps & Bot Chat

Bisa dicolokin ke aplikasi komputer buat kasir toko fisik, atau dihubungin ke Bot Telegram dan engine WhatsApp broadcast biar bisa jualan otomatis lewat chat.

### 🔥 Keunggulan Utama Manfaatin Open API Serpul

Kenapa sih mending pake Open API Serpul dibanding bikin sistem sendiri dari nol atau colok vendor luar langsung? Ini keuntungan gedenya:.

* Gak Perlu Pusing Bikin Database Inti: Sistem pendaftaran user (Auth), daftar produk, proses transaksi, sampai logika sukses/gagal transaksi udah digendong semua sama server Serpul. Tinggal panggil aja jalurnya, gak usah koding database backend dari nol.

### 🛠️ Kebebasan Full Custom: Tambah Fitur Keren di Luar Serpul!

Ini dia bagian paling juara. Pake Open API Serpul bukan berarti Sobat Serpul dibatasi cuma bisa pake fitur yang ada di aplikasi Serpul. Lewat pengembangan Full Custom (Custom Backend Sendiri), Sobat Serpul bisa bikin fitur-fitur baru yang mandiri dan gak ada hubungannya sama Serpul.

Sobat Serpul tinggal sewa hosting/VPS sendiri buat nampung fitur kustom tersebut. Contohnya:

#### 1. Pembuatan QRIS Merchant Sendiri

Sobat Serpul pengen aplikasi kustomnya bisa ngasih fitur QRIS buat downline atau toko-toko kelontong? Bisa banget! Lewat kodingan backend kustom, Sobat Serpul bisa mengintegrasikan payment gateway pihak luar ke dalam aplikasi buatan sendiri. Jadi, aplikasi Sobat Serpul bisa nerbitin QRIS Merchant, menerima pembayaran digital, dan mengelola saldonya secara mandiri di luar sistem Serpul.

#### 2. Fitur Marketing & Keanggotaan Kustom

Sobat Serpul bisa tambahin fitur sistem poin berhadiah (reward points), tingkat keanggotaan (Membership Tier: Silver, Gold, Platinum dll), voucher diskon khusus hari raya, sampai sistem komisi affiliate berjenjang yang logikanya diatur sendiri sepenuhnya.

#### 3. Jualan Produk Fisik & Jasa Lainnya

Pengen gabungin aplikasi jualan pulsa dengan jualan barang fisik (kayak kaos, aksesoris), atau layanan jasa (kayak joki game manual dan akun premium Netflix/Spotify)? Sangat bisa! Semua produk di luar Serpul ini tinggal dimasukkan ke database custom backend sendiri.

### 🔄 Sistem Dua Jalur Berdampingan

Dengan metode kustom ini, aplikasi Sobat Serpul bakal membelah perintah jadi DUA JALUR GUDANG SEKALIGUS yang berjalan barengan dengan sangat rapi:

* Jalur A (Melalui OpenAPI Serpul): Dipake buat mengotomatisasi semua produk, pulsa, dan produk lainnya yang udah tersedia di dashboard serpul.
* Jalur B (Melalui Custom Backend Sendiri): Dipake buat jalanin fitur-fitur kustom mandiri buatan sendiri, ngelola QRIS Merchant, serta memproses produk-produk luar alternatif.

### 🎯 Contoh Nyata Cara Kerjanya di Balik Layar

Pas aplikasi atau web Sobat Serpul udah jadi, pembeli bakal ngerasain kemudahan yang luar biasa karena semuanya berjalan otomatis:

* Contoh Kejadian 1 (Beli Produk Serpul):

  Pelanggan buka aplikasi Sobat Serpul -> pilih Pulsa Telkomsel -> klik Beli. Sistem aplikasi mendeteksi ini produk PPOB -> aplikasi langsung nembak jalur OpenAPI Serpul -> saldo terpotong dan pulsa masuk ke HP pelanggan dalam hitungan detik.
* Contoh Kejadian 2 (Bayar Pakai QRIS / Beli Produk Luar):

  Pelanggan mau top-up saldo aplikasi pake QRIS, atau mau beli akun premium Netflix. Sistem aplikasi mendeteksi ini fitur di luar Serpul -> aplikasi otomatis ngalihin perintah ke jalur Custom Backend milik Sobat Serpul sendiri -> transaksi diproses dan uang masuk ke rekening payment gateway Sobat Serpul sendiri.

### 🍽️ Analogi Gampang: Open API itu Kayak "Pelayan"

Bayangin Sobat Serpul punya **Restoran Keren** pake nama brand sendiri. Nah, pembagian tugas di dalem restoran itu kayak gini:

* **Pelanggan (User/ Agen):** Orang yang dateng, duduk, terus liat buku menu (Tampilan Web, APK, atau PWA Sobat Serpul). Mereka tinggal klik-klik aja mau pesen apa.
* **Dapur Utama Raksasa (Server Serpul):** Dapur super gede di bagian belakang yang punya stok bahan makanan lengkap banget, mulai dari pulsa, kuota, token, sampai voucher game.
* **Si Pelayan atau (Open API):** Nah, Open API ini perannya jadi si pelayan pinter yang berdiri di depan meja pelanggan.

#### Cara Kerjanya Gampang Banget:

1. Pelanggan pesen "Pulsa Telkomsel" lewat layar aplikasi Sobat Serpul.
2. Si **Pelayan (Open API)** langsung sigap nyatet pesenan itu, terus lari ke **Dapur Utama (Serpul)** buat ngambil pulsanya.
3. Gak butuh waktu lama, si **Pelayan (Open API)** balik lagi ke meja pelanggan bawa pulsanya dalam kondisi sukses.

User atau pelanggan gak perlu tahu gimana ribetnya dapur masak pulsanya, gak perlu masuk ke dalem dapur yang panas, dan gak perlu kenal sama koki di dalemnya. Pelanggan cuma tahu pesenannya beres di meja berkat si pelayan pinter ini.

Jadi, gak ada batasan lagi buat berkreasi. Open API Serpul siap jadi mesin belakang layar, sementara Sobat Serpul bebas bangun Full custom brand sendiri
