Getting started
BISA TAMPIL merupakan platform Video Conference yang dapat digunakan secara publik oleh semua orang baik melalui aplikasi web atau melalui mobile application Android dan IoS (Available Juni 2020). Saat ini tersedia versi API (web service) yang dapat digunakan oleh aplikasi pihak ke-3 untuk dapat menggunakan service BISA TAMPIL. melalui service ini, provider pihak ke-3 dapat menjalankan fungsi dari BISA TAMPIL di aplikasi atau sistem yang dikembangkan.
Untuk dapat menggunakan aplikasi ini, anda harus mengetahui:
- bagaimana REST API bekerja, bagaimana cara mengaksesnya
- komunikasi web service dengan JSON
- Dasar pengetahuan JWT
API ini menggunakan 2 endpoints yaitu Staging untuk ujicoba penggunaan API dan Production untuk live sistem. untuk mendapatkan endpoints baik staging maupun production, anda perlu terdaftar sebagai mitra BISA TAMPIL, dan memiliki key akses dan Authorization Access.Untuk Mendapatkan Akses API, hubungi:
Cara Penggunaan
POST Tambah User
API ini digunakan untuk menambahkan user melalui sistem atau aplikasi anda. user yang ditambahkan akan masuk kedalam user BISA TAMPIL. agar setiap user dapat membuat room, serta membagikan room untuk video conference, diperlukan user yang teregistrasi di BISA TAMPIL
Body JSON
{
"nama":[NAMA ANDA]
"email":[EMAIL ANDA]
"password":[PASSWORD ANDA]
}
Headers
Content-type : application/json
x-api-key : [your key]
Contoh Penggunaan
{
"nama":"Info BISA AI"
"email":"info@bisa.ai"
"password":"iniadalahpassword"
}
Headers
Content-type : application/json
x-api-key : 123
Response Berhasil
{
"description":"berhasil"
"status_code":200
}
Response Gagal
{
"description":"email telah digunakan"
"status_code":400
}
POST Login
API ini digunakan untuk authentikasi kedalam sistem BISA TAMPIL
Body JSON
{
"username":[USERNAME ANDA]
"password":[PASSWORD ANDA]
}
Headers
Content-Type : application/json
Contoh Penggunaan
{
"username":"info"
"password":"iniadalahpassword"
}
Headers
Content-type : application/json
Response Berhasil
{
"access_token": "token1234"
}
Response Gagal
{
"description":"invalid credential"
"status_code":401
}
GET Cek Credential
API ini digunakan untuk mendapatkan informasi kredensial dari User yang telah LOGIN, informasi seperti nama, email, status, dll
Headers
Authorization : JWT [TOKEN AUTH]
x-api-key : [API KEY ANDA]
Contoh Penggunaan (header)
"Authorization": JWT token1234
"x-api-key" : 123
Response Berhasil
{
"nama": "[nama]"
"email": "[email]"
}
Response Gagal
{
"description":"invalid credential"
"status_code":401
}
POST Update Profile
API ini digunakan untuk mengubah profile dari user seperti nama dan password.
Headers
Authorization : JWT [TOKEN AUTH]
Content-Type : application/json
x-api-key : [API KEY ANDA]
Body JSON
{
"nama":[NAMA ANDA] (opsional)
"password":[PASSWORD BARU ANDA] (opsional)
}
Contoh Penggunaan (header)
"Authorization": JWT token1234
"Content-Type": application/json
"x-api-key" : 123
Response Berhasil
{
"description":"berhasil"
"status_code":200
}
Response Gagal
{
"description":"invalid credential"
"status_code":401
}
GET Lihat Paket
Lihat paket video conference yang tersedia untuk pengguna. Paket ini dapat digunakan baik GRATIS maupun berbayar oleh pengguna
Headers
Authorization : JWT [TOKEN AUTH]
x-api-key : [API KEY ANDA]
PARAM
{
"is_aktif":[KODE aktif=1, non=2] (opsional)
"id_paket":[id_paket] (opsional)
"page":[page] (opsional)
"q":[kata kunci] (opsional)
}
Contoh Penggunaan
https://[SERVER_ADDRESS]/[API]/paket/get_paket?is_aktif=1
Headers
"Authorization": JWT token1234
Response Berhasil
{
"data":[
"fitur":"layanan x"
"harga":20000
},{..}],
"offset":26
"page":1
"row_count":5
"status_code":200
}
Response Gagal
{
"description":"invalid credential"
"status_code":401
}
POST Beli Paket
Beli paket video conference yang tersedia untuk pengguna. Paket ini dapat digunakan baik GRATIS maupun berbayar oleh pengguna
Headers
Authorization : JWT [TOKEN AUTH]
x-api-key : [API KEY ANDA]
Content-type : application/json
BODY JSON
{
"id_paket":[ID PAKET yang akan dibeli]
"kupon": [Jika terdapat KODE kupon]
}
Contoh Penggunaan
{
"id_paket":1
"kupon": "1daj319ja"
}
Headers
Authorization : JWT token1234
Content-type : application/json
x-api-key : 123
Response Berhasil
{
"description":"berhasil"
"status_code":200
}
Response Gagal
{
"description":"anda sudah menggunakan kupon"
"status_code":400
}
GET Lihat Transaksi Paket
Lihat transaksi pembelian paket oleh pengguna.
Headers
Authorization : JWT [TOKEN AUTH]
x-api-key : [API KEY ANDA]
PARAM
{
"id_customer_beli_paket":[id pembelian paket oleh customer] (opsional)
"status":[1=belum bayar, 2=sudah bayar, 3=sudah selesai, 0=gagal] (opsional)
"id_paket":[id_paket] (opsional)
"order_by":[asc/desc] (opsional)
"room_number":[Room ID] (opsional)
"page":[page] (opsional)
"q":[kata kunci] (opsional)
}
Contoh Penggunaan
URL: https://[SERVER_ADDRESS]/[API]/paket/get_transaksi_paket?id_customer_beli_paket=1&status=1
Headers
Authorization : JWT token1234
Content-type : application/json
x-api-key : 123
Response Berhasil
{
"description":"berhasil"
"status_code":200
}
Response Gagal
{
"description":"invalid credentials"
"status_code":400
}
GET Lihat durasi penggunaan Paket
Lihat sisa durasi penggunaan paket
Headers
Authorization : JWT [TOKEN AUTH]
x-api-key : [API KEY ANDA]
PARAM
{
"id_customer_beli_paket":[id pembelian paket oleh customer] (opsional)
"page":[page] (opsional)
"q":[kata kunci] (opsional)
}
Contoh Penggunaan
URL: https://[SERVER_ADDRESS]/[API]/paket/get_durasi?id_customer_beli_paket=1&page=1
Headers
Authorization : JWT token1234
x-api-key : 123
Response Berhasil
{
"durasi_paket":"1000"
"durasi_terpakai":"1"
"id_customer":"1"
"id_customer_beli_paket":"1"
"id_paket":"1"
"nama_paket":"1"
}
Response Gagal
{
"description":"invalid credentials"
"status_code":400
}
GET Lihat penggunaan Logs
Lihat detail logs/catatan penggunaan Video Conference
Headers
Authorization : JWT [TOKEN AUTH]
x-api-key : [API KEY ANDA]
PARAM
{
"id_customer_beli_paket":[id pembelian paket oleh customer] (opsional)
"page":[page] (opsional)
"q":[kata kunci] (opsional)
}
Contoh Penggunaan
URL: https://[SERVER_ADDRESS]/[API]/paket/get_paket_logs?id_customer_beli_paket=1&page=1
Headers
Authorization : JWT token1234
x-api-key : 123
Response Berhasil
{
"durasi":"1000"
"id_customer":""
"id_customer_beli_paket":""
"id_customer_beli_paket_logs":""
"is_stop":""
"jumlah_pengguna":""
"nama_paket":""
"nama_user":""
"waktu_mulai":""
"waktu_berakhir":""
}
Response Gagal
{
"description":"invalid credentials"
"status_code":400
}
GET Lihat Room Meeting
Lihat Room Meeting
Headers
Authorization : JWT [TOKEN AUTH]
x-api-key : [API KEY ANDA]
PARAM
{
"id_customer_beli_paket":[id pembelian paket oleh customer] (Wajib)
"jenis":[1=moderator, 2=attendee] (Wajib)
}
Contoh Penggunaan
URL: https://[SERVER_ADDRESS]/[API]/paket/share_room?id_customer_beli_paket=1&jenis=1
Headers
Authorization : JWT token1234
x-api-key : 123
Response Berhasil
{
"text":"saya mengirimkan anda akses ke Video Conference BISA TAMPIL melalui. Akses room : 12345 \n Room Password attendee : bisatampil \n Download Aplikasi Android dan IOS untuk menggunakan layanan Bisa Tampil"
"status_code":200
}
Response Gagal
{
"description":"tidak ada room"
"status_code":400
}