API Integrations

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 Mengakses Menu Integrations

1. Login dan Akses Aplikasi

   

   Masuk ke akun AlurKerja Anda. Setelah berada di dashboard, pastikan Anda telah memilih Workspace yang benar, lalu klik menu Studio melalui menu Workspace > Go to Studio.

2. Buka Halaman Integrations

   

   Pada bilah navigasi di dalam Studio, klik menu Integrations.

3. Halaman Dashboard Integrations

   

   Halaman ini merupakan Dashboard pada menu Integrations. Pada halaman ini pengguna dapat melihat dan mengelola jenis integrasi yang tersedia di AlurKerja. Di bagian kiri terdapat menu integrasi yang dapat dipilih, terdiri dari Telegram, WhatsApp, Odoo, API, DB, Templates dan Auth Tokens.

   

   Saat salah satu menu dipilih, di area kanan akan ditampilkan daftar konfigurasi untuk jenis integrasi tersebut, lengkap dengan informasi nama konfigurasi, waktu pembuatan, serta aksi untuk mengubah atau menghapus konfigurasi. Dari halaman ini juga pengguna dapat menambahkan konfigurasi integrasi baru melalui tombol yang tersedia di bagian kanan atas.

Langkah-langkah Integrasi API

1. Buka Menu API

   

   Pada halaman Dashboard Integrations, pilih menu API pada panel sebelah kiri. Setelah menu API dipilih, di area kanan akan muncul daftar API Configurations yang sudah terdaftar. Pada tabel konfigurasi API terdapat informasi berikut:

   • No: Nomor urut konfigurasi
   • Name: Nama konfigurasi API
   • Method: Menampilkan metode HTTP yang digunakan.
   • URL: Alamat endpoint API yang akan diakses sesuai konfigurasi.
   • Auth Type: Jenis autentikasi yang digunakan untuk mengakses API.
   • Created At: Tanggal dan waktu pembuatan konfigurasi API.
   • Action: Ikon pensil untuk mengubah konfigurasi dan ikon tempat sampah untuk menghapus konfigurasi.
   • Add New Configuration: Untuk menambahkan konfigurasi API baru.

2. Menambahkan Konfigurasi API Baru

   

   Setelah klik Add New Configuration pada menu API, sistem akan menampilkan halaman API Configurations dengan formulir Configuration Details.
   Pada bagian ini, isi beberapa field berikut:

   • Configuration Name
     Masukkan nama configuration API yang ingin digunakan.
   • Method
     Pilih metode HTTP yang diperlukan untuk memanggil API.
   • URL
     Masukkan alamat endpoint API yang akan dihubungkan.
   • Authentication
     Pilih tipe autentikasi yang digunakan oleh API. Jika memilih None, berarti API tidak memerlukan autentikasi. Jika tipe lain dipilih, form autentikasi yang diperlukan akan ditampilkan sesuai kebutuhan.
   • Headers
     Tambahkan key dan value untuk header yang diperlukan API.
   • Parameters
     Tambahkan parameter query (jika dibutuhkan) yang akan dikirimkan bersama request API.
   • Body
     Masukkan payload atau isi body request (khusus untuk metode seperti POST atau PUT) sesuai format yang diperlukan oleh API.

   Selain itu terdapat beberapa tombol dengan fungsinya:

   • Test API
     Digunakan untuk menguji apakah konfigurasi yang diisi sudah benar dan dapat diakses. Hasil pengujian akan ditampilkan di panel Response pada sisi kanan.
   • Save Configuration
     Digunakan untuk menyimpan konfigurasi API. Jika penyimpanan berhasil, konfigurasi baru akan muncul di daftar API Configurations.
   • Back to List
     Digunakan untuk kembali ke daftar konfigurasi API
   • Remove
     Digunakan untuk menghapus konfigurasi yang sedang dibuka.

3. Mengubah atau Menghapus Konfigurasi API

   

   Pada halaman daftar API Configurations, setiap baris konfigurasi memiliki kolom Action yang berisi ikon:

   • Ikon pensil: Digunakan untuk mengubah konfigurasi.
   • Ikon tempat sampah: Digunakan untuk menghapus konfigurasi

   Mengubah Konfigurasi API

   
   • Buka menu Integrations kemudian pilih API
   • Pada tabel API Configurations, klik ikon pensil pada konfigurasi yang ingin diubah.
   • Sistem akan menampilkan halaman Configuration Details yang berisi name, method, url, authentication, headers, parameters, body.
   • Lakukan perubahan pada field yang diperlukan.
   • Klik Test API untuk memastikan koneksi valid.
   • Klik Save Configuration untuk menyimpan perubahan.

   Konfigurasi yang telah diperbarui akan langsung tersimpan dan digunakan pada proses pemanggilan API yang terkait.

   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.
      • Konfigurasi penghapusan.

   2. Dari Halaman Detail Konfigurasi

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