Integrasi API digunakan untuk menghubungkan data dan proses yang ada di AlurKerja dengan sistem atau layanan eksternal melalui antarmuka pemrograman aplikasi (API). Melalui integrasi ini, berbagai informasi seperti data pengguna, aktivitas proses, atau transaksi operasional dapat dikirim, diterima, atau disinkronkan secara otomatis sesuai konfigurasi yang telah ditentukan. Dengan demikian, pengguna dapat mengurangi kerja manual, memastikan konsistensi dan akurasi data antar platform, serta mendukung otomatisasi proses bisnis agar berjalan lebih cepat, efisien, dan terpusat melalui koneksi API.

Langkah-langkah Integrasi API

Buka Menu API

1. Masuk ke Dashboard Integrations.
2. Pilih menu API Call pada panel kiri.
3. Sistem akan menampilkan daftar API Call Configuration yang tersedia.
4. Klik Add New API Call Configuration untuk menambah konfigurasi baru.

Menambahkan Konfigurasi API Baru

1. Setelah klik Add New API Call Configuration pada menu API, sistem akan menampilkan formulir Configuration. Pada bagian ini, isi beberapa field berikut:

   • API Name : Nama konfigurasi API.
   • Description : Isi deskripsi singkat untuk menjelaskan tujuan konfigurasi (opsional).
   • Method : Pilih metode HTTP yang diperlukan untuk memanggil API.
   • URL : Alamat Endpoint API.
   • Authentication : Pilih tipe autentikasi (atau None jika tidak diperlukan).
   • Headers : Tambahkan key dan value untuk header yang diperlukan API.
   • Parameters : Tambahkan parameter query (jika dibutuhkan).
   • Body : Isi payload request untuk metode POST/PUT.

2. Klik Test untuk memastikan konfigurasi benar.

3. Klik Save Configuration untuk menyimpan konfigurasi.

Mengubah atau Menghapus Konfigurasi API

Mengubah Konfigurasi API

1. Pada tabel API Configurations, klik ikon pensil pada konfigurasi yang ingin diubah.
2. Sistem akan menampilkan halaman Configuration Details yang berisi API name, description, method, url, authentication, headers, parameters, body.
3. Lakukan perubahan pada field yang diperlukan.
4. Klik Test untuk memastikan koneksi valid.
5. Klik Update Configuration untuk menyimpan perubahan.

Menghapus Konfigurasi API

Terdapat dua cara untuk menghapus konfigurasi:

1. Dari Daftar Konfigurasi

   
   • Pada tabel API Configurations, klik ikon tempat sampah pada baris konfigurasi yang ingin dihapus.
   • Konfirmasi penghapusan.

2. Dari Halaman Detail Konfigurasi

   
   • Buka konfigurasi yang ingin dihapus.
   • Klik tombol remove di bagian kanan judul Configuration Details.
   • Konfirmasi penghapusan.

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.