Integrasi API digunakan untuk menghubungkan data dan proses yang ada di AlurKerja dengan sistem atau layanan eksternal melalui API. Melalui integrasi ini, data seperti informasi pengguna, aktivitas proses, atau transaksi operasional dapat dikirim, diterima, atau disinkronkan secara otomatis sesuai konfigurasi yang telah ditentukan.

Konfigurasi API Call mendukung dua environment, yaitu Test Environment dan Live Environment. Dengan fitur ini, pengguna dapat membuat dan menguji konfigurasi API terlebih dahulu pada environment test tanpa memengaruhi konfigurasi yang digunakan oleh user di environment live.

Langkah-langkah Integrasi API

Membuka Menu API Call

1. Masuk ke halaman Studio.
2. Pilih menu Integration pada panel kiri.
3. Klik submenu API Call.
4. Sistem akan menampilkan halaman API Call Configurations.

Menambahkan Konfigurasi API Baru

1. Pada halaman API Call Configurations, klik tombol Add New API Call Configuration.

   

2. Sistem akan menampilkan halaman New Api Configuration.

   

3. Isi field berikut:

   • API Name: Nama konfigurasi API yang akan dibuat.
   • Description: Deskripsi singkat untuk menjelaskan tujuan konfigurasi API. Field ini bersifat opsional.

4. Pada bagian Configuration Details, pilih environment yang ingin dikonfigurasi:

   
   • Test Environment: Digunakan untuk membuat atau menguji konfigurasi API pada environment test. Konfigurasi pada environment ini tidak akan memengaruhi user di environment live.
   • Live Environment: Digunakan untuk membuat konfigurasi API yang akan digunakan pada environment live.
   • Catatan: Jika API Call digunakan pada BPMN, maka konfigurasi API yang dijalankan akan mengikuti environment BPMN yang digunakan. BPMN pada Test Environment akan menggunakan konfigurasi API test, sedangkan BPMN pada Live Environment akan menggunakan konfigurasi API live.

5. Setelah memilih environment, isi detail konfigurasi API berikut:

   • Method: Pilih metode HTTP yang digunakan, seperti GET, POST, PUT, PATCH, atau DELETE.
   • URL: Masukkan alamat endpoint API yang akan dipanggil.
   • Authentication: Pilih tipe autentikasi yang digunakan. Jika API tidak memerlukan autentikasi, pilih None.
   • Headers: Tambahkan key dan value untuk header yang diperlukan oleh API.
   • Parameters: Tambahkan parameter query jika API membutuhkan parameter tambahan.
   • Body: Isi payload request jika API menggunakan metode seperti POST, PUT, atau PATCH.

6. Klik tombol Test untuk memastikan konfigurasi API dapat terhubung dengan benar.

7. Jika konfigurasi sudah sesuai, klik tombol Save Configuration untuk menyimpan konfigurasi.

Mengubah Konfigurasi API

1. Pada halaman API Call Configurations, klik ikon pensil pada konfigurasi API yang ingin diubah.

   

2. Sistem akan menampilkan halaman Edit Api Configuration.

   

3. Lakukan perubahan pada field yang diperlukan.

4. Klik tombol Test untuk memastikan konfigurasi API masih valid.

5. Klik tombol Update Configuration untuk menyimpan perubahan.

Menghapus Konfigurasi API

Konfigurasi API dapat dihapus melalui dua cara:

1. Menghapus dari Daftar Konfigurasi

   
   • Pada halaman API Call Configurations, klik ikon tempat sampah pada baris konfigurasi yang ingin dihapus.
   • Konfirmasi penghapusan untuk menghapus konfigurasi API.

2. Menghapus dari Halaman Edit Konfigurasi

   
   • Buka konfigurasi API yang ingin dihapus.
   • Pada halaman Edit Api Configuration, klik tombol Remove di bagian Configuration Details.
   • Konfirmasi penghapusan untuk menghapus konfigurasi API.

Konfigurasi API Call pada BPMN

Konfigurasi API Call pada BPMN digunakan untuk menghubungkan API Configuration yang sudah dibuat pada menu Integrations ke dalam alur proses BPMN. Dengan konfigurasi ini, sistem dapat melakukan pemanggilan API secara otomatis melalui Service Task sesuai API yang dipilih.

1. Buka BPMN Editor pada AlurKerja.

2. Tambahkan elemen Service Task pada diagram proses.

   

3. Klik Service Task yang akan dikonfigurasi.

4. Di panel Properties, klik tab API Request

   

5. Konfigurasi API:

   
   • Select API Configuration : Digunakan untuk memilih API yang akan dipanggil.
   • Result Variable : Digunakan untuk mengambil nilai tertentu dari response API.
   • Output Variable : Nama variable proses di Camunda untuk menyimpan hasil response API secara keseluruhan.

6. Setelah selesai, klik Save dan Deploy BPMN.

7. Pilih environment deploy sesuai kebutuhan: