Dokumentasi End-Point API HARPAY (Kelompok 2, Pemrograman Integratif A)

dokumentasi.md

Dokumentasi End-Point API HARPAY (Kelompok 2 | Pemrograman Integratif A)

Anggota Kelompok 2

1. Haffif Rasya Fauzi (5027201002)
2. Fairuz Azka Maulana (5027201017)
3. Rama Muhammad Murshal (5027201041)

Deskripsi Sistem

HARPAY merupakan sebuah sistem API yang dapat digunakan pengguna untuk melakukan pembayaran dan pembelian token listrik berdasarkan data yang tersedia.

Fungsionalitas Utama API

• Registrasi, login
• Update pin, update password
• Cek saldo, cek history transaksi
• Top-up saldo, transfer saldo ke teman
• Cek status pembayaran listrik rumah, pembayaran listrik rumah
• Cek sisa token rumah, pembelian token rumah
• Pembayaran e-commerce
• Get user profile

Base URL

https://harpay-api.herokuapp.com/

End-Point Yang Tersedia

Method	End-Point	Autentikasi	Deskripsi
GET	/fitur	Tidak	Mendapatkan semua informasi fitur sistem API
GET	/fitur/:idFitur	Tidak	Mendapatkan informasi fitur spesifik sistem API
POST	/auth/registrasi	Tidak	Registrasi akun
POST	/auth/login	Tidak	Login akun
POST	/auth/updatePin	Tidak	Update pin pengguna
POST	/auth/updatePassword	Ya	Update password pengguna
GET	/transaksi/cekSaldo	Ya	Cek saldo pengguna
GET	/transaksi/cekHistory	Ya	Cek history transaksi pengguna
POST	/transaksi/topup	Ya	Topup saldo pengguna
POST	/transaksi/transferSaldo	Ya	Transfer saldo pengguna
POST	/transaksi/cekPembayaranListrik	Ya	Cek status pembayaran listrik rumah
POST	/transaksi/pembayaranListrik	Ya	Pembayaran listrik rumah
POST	/transaksi/cekTokenListrik	Ya	Cek sisa token listrik rumah
POST	/transaksi/pembelianTokenListrik	Ya	Pembelian token listrik rumah
POST	/transaksi/bayar	Ya	Pembelian Barang
GET	/auth/profile	Ya	Mendapatkan profile user yang sedang login

Data Rumah Yang Menggunakan Listrik Pasca-Bayar

Notes: Rumah dengan atribut pembayaranBulan yang bernilai false, diberi anggapan belum melakukan pembayaran listrik ini bulan ini dan harus membayar sejumlah nilai pada atribut jumlahBayaranBulan. Atribut _id digunakan sebagai atribut idPelanggan saat ingin melakukan transaksi.

Data Rumah Yang Menggunakan Listrik Pra-Bayar

Notes: atribut sisaToken adalah sisa token untuk rumah tersebut. Atribut _id digunakan sebagai atribut idPelanggan saat ingin melakukan transaksi.

Penjelasan Detail Setiap End-Point

Berikut merupakan penjelasan detail dari setiap end-point yang tersedia pada sistem API ini:

Get All Fitur

• Method: GET
• URL: https://harpay-api.herokuapp.com/fitur/
• Autentikasi: Tidak
• Parameter: -

Contoh: GET https://harpay-api.herokuapp.com/fitur/

Respon:

Get Spesifik Fitur

• Method: GET
• URL: https://harpay-api.herokuapp.com/fitur/:fiturId
• Autentikasi: Tidak
• Parameter: -

Contoh: GET https://harpay-api.herokuapp.com/fitur/6254cb6404d508de85f05e64

Respon:

Registrasi Akun

• Method: POST
• URL: https://harpay-api.herokuapp.com/auth/registrasi
• Autentikasi: Tidak
• Parameter:

Atribute	TipeData	Deskripsi
name	string	Nama yang menunjukkan identitas pengguna
email	string	Menggunakan format email yang sesuai, satu email untuk satu akun
noTelp	number	Diawali dengan angka 62, kemudian menyesuaikan format nomor berikutnya
password	string	Password pengguna, sebaiknya menggunakan password yang kuat
konfirmasiPassword	string	Konfirmasi password pengguna, sebaiknya menggunakan password yang kuat
pin	number	Harus berupa 6 digit number, sebaiknya menggunakan digit yang unik
konfirmasiPin	number	Harus berupa 6 digit number, sebaiknya menggunakan digit yang unik

Contoh: POST https://harpay-api.herokuapp.com/auth/registrasi

Respon:

Login Akun

• Method: POST
• URL: https://harpay-api.herokuapp.com/auth/login
• Autentikasi: Tidak
• Parameter:

Atribute	TipeData	Deskripsi
email	string	Email pengguna
password	string	Password pengguna

Contoh: POST https://harpay-api.herokuapp.com/auth/login

Respon:

Contoh Menyimpan Autentikasi Token Login

Update Pin

• Method: POST
• URL: https://harpay-api.herokuapp.com/auth/updatePin
• Autentikasi: Ya → Token yang didapatkan saat login, disimpan pada Authorization Bearer
• Parameter:

Atribute	TipeData	Deskripsi
pin	number	Pin baru pengguna
konfirmasiPin	number	Konfirmasi pin baru pengguna

Contoh: POST https://harpay-api.herokuapp.com/auth/updatePin

Respon:

Update Password

• Method: POST
• URL: https://harpay-api.herokuapp.com/auth/updatePassword
• Autentikasi: Ya → Token yang didapatkan saat login, disimpan pada Authorization Bearer
• Parameter:

Atribute	TipeData	Deskripsi
passwordBaru	string	Password baru pengguna
konfirmasiPasswordBaru	string	Konfirmasi password baru pengguna

Contoh: POST https://harpay-api.herokuapp.com/auth/updatePassword

Respon:

Cek Saldo Pengguna

• Method: GET
• URL: https://harpay-api.herokuapp.com/transaksi/cekSaldo
• Autentikasi: Ya → Token yang didapatkan saat login, disimpan pada Authorization Bearer
• Parameter: -

Contoh: GET https://harpay-api.herokuapp.com/transaksi/cekSaldo

Respon:

Topup Saldo Pengguna

• Method: POST
• URL: https://harpay-api.herokuapp.com/transaksi/topup
• Autentikasi: Ya → Token yang didapatkan saat login, disimpan pada Authorization Bearer
• Parameter:

Atribute	TipeData	Deskripsi
nominal	number	Nominal topup yang ingin dilakukan pengguna

Contoh: POST https://harpay-api.herokuapp.com/transaksi/topup

Respon:

Transfer Saldo

• Method: POST
• URL: https://harpay-api.herokuapp.com/transaksi/transferSaldo
• Autentikasi: Ya → Token yang didapatkan saat login, disimpan pada Authorization Bearer
• Parameter:

Atribute	TipeData	Deskripsi
noTelp	number	Nomor telepon pengguna lain yang ingin di transfer
nominal	number	Nominal topup yang ingin dilakukan pengguna
pin	number	Pin pengguna

Contoh: POST https://harpay-api.herokuapp.com/transaksi/transferSaldo

Respon:

Cek Data Pembayaran Listrik Rumah

• Method: POST
• URL: https://harpay-api.herokuapp.com/transaksi/cekPembayaranListrik
• Autentikasi: Ya → Token yang didapatkan saat login, disimpan pada Authorization Bearer
• Parameter:

Atribute	TipeData	Deskripsi
idPelanggan	string	ID rumah pelanggan pasca-bayar yang ingin di cek status pembayaran listriknya (menggunakan data di atas)

Contoh: POST https://harpay-api.herokuapp.com/transaksi/cekPembayaranListrik

Respon:

Pembayaran Listrik Rumah

• Method: POST
• URL: https://harpay-api.herokuapp.com/transaksi/pembayaranListrik
• Autentikasi: Ya → Token yang didapatkan saat login, disimpan pada Authorization Bearer
• Parameter:

Atribute	TipeData	Deskripsi
idPelanggan	string	ID rumah pelanggan pasca-bayar yang ingin di cek status pembayaran listriknya (menggunakan data di atas)
pin	number	PIN pengguna

Contoh: POST https://harpay-api.herokuapp.com/transaksi/pembayaranListrik

Respon:

Cek Data Token Listrik Rumah

• Method: POST
• URL: https://harpay-api.herokuapp.com/transaksi/cekTokenListrik
• Autentikasi: Ya → Token yang didapatkan saat login, disimpan pada Authorization Bearer
• Parameter:

Atribute	TipeData	Deskripsi
idPelanggan	string	ID rumah pelanggan pra-bayar yang ingin di cek sisa token listriknya (menggunakan data di atas)

Contoh: POST https://harpay-api.herokuapp.com/transaksi/cekTokenListrik

Respon:

Pembelian Token Listrik Rumah

• Method: POST
• URL: https://harpay-api.herokuapp.com/transaksi/pembelianToken
• Autentikasi: Ya → Token yang didapatkan saat login, disimpan pada Authorization Bearer
• Parameter:

Atribute	TipeData	Deskripsi
idPelanggan	string	ID rumah pelanggan pra-bayar ingin di tambah jumlah token listriknya (menggunakan data di atas)
nominal	number	Nominal token yang ingin dibeli, hanya dapat berada pada kisaran 20000, 50000, 100000
pin	number	PIN pengguna

Contoh: POST https://harpay-api.herokuapp.com/transaksi/pembelianTokenListrik

Respon:

Cek History Transaksi Pengguna

• Method: GET
• URL: https://harpay-api.herokuapp.com/transaksi/cekHistory
• Autentikasi: Ya → Token yang didapatkan saat login, disimpan pada Authorization Bearer
• Parameter: -

Contoh: GET https://harpay-api.herokuapp.com/transaksi/cekHistory

Respon:

Pembelian Barang

• Method: POST
• URL: https://harpay-api.herokuapp.com/transaksi/bayar
• Autentikasi: Ya → Token yang didapatkan saat login, disimpan pada Authorization Bearer
• Parameter:

Atribute	TipeData	Deskripsi
jumlahBayar	number	Nominal harga barang yang ingin dibeli
pin	number	PIN pengguna

Contoh: POST https://harpay-api.herokuapp.com/transaksi/bayar

Respon:

Get Profile

• Method: GET
• URL: https://harpay-api.herokuapp.com/auth/profile
• Autentikasi: Ya → Token yang didapatkan saat login, disimpan pada Authorization Bearer
• Parameter: -

Contoh: GET https://harpay-api.herokuapp.com/auth/profile

Respon: