Creating API From Data Source

Creating API From Data Source

BigEnvelope memungkinkan admin untuk dapat membuat API dari data source berupa database tanpa harus menulis code.

Creating Connection to Data Source

Sebelum dapat membuat API, admin harus terlebih dahulu memastikan bahwa koneksi ke database sudah terdaftar. Hal ini dapat dilakukan di halaman Connection

Jika koneksi ke database sudah terdaftar, lanjutkan ke tahap 2.1.2. Jika belum, daftarkan koneksi ke database dengan menekan tombol “Add New”.

Anda akan disajikan tampilan form koneksi ke database. Silahkan isi masukan nama koneksi, adapter, host, port, database name, username, dan password. Lalu nyalakan connection status ke posisi “ON”.

Untuk mengetes bahwa BigEnvelope sudah dapat melakukan koneksi dengan masukan yang telah diberikan, tekan tombol “Test Connection”. Jika pengisian sudah selesai tekan tombol “Submit”.

API Settings

Untuk membuat API baru, masuk ke menu API lalu tekan tombol “Add new API”.

Isi form dengan masukan nama API, dan waktu cache yang diinginkan (default tidak ada cache). Biarkan tipe API di posisi “Common SQL”.

Pada form Connection, pilih koneksi ke database yang diinginkan.

Untuk memfasilitasi pembuatan query tanpa harus menulis code, BigEnvelope menyediakan UI berupa Query Builder yang memungkinkan admin untuk membuat query berdasarkan inputan nama tabel, join, select, where, dsb.

BigEnvelope juga memfasilitasi penulisan query SQL secara manual. Query juga dapat menerima masukan parameter dengan cara memanggil karakter “:” sebelum nama parameter. Parameter ini akan menjadi parameter masukan dari API yang akan dibuat.

Untuk mengetes query, admin dapat menekan tombol “Test API”. Jika sudah selesai, admin dapat menekan tombol “Save”.

Creating Consumer Profile

Untuk membuat profile consumer yang akan menggunakan API, admin dapat melakukannya di halaman Consumer dan menekan tombol “Add API User”.

Admin dapat mengisi form berisi nama consumer, IP consumer, dan batas rate limit yang dibolehkan untuk consumer itu. Untuk masukan IP juga mendukung CIDR notation untuk memasukan range beberapa IP sekaligus.

Giving Consumer permission

Untuk memberi permission consumer untuk menggunakan API, admin dapat masuk ke halaman access control dari consumer yang dimaksud.

Untuk memberikan akses kepada Consumer, admin hanya perlu menekan checklist “Access API” dari API yang dimaksud.