api API Gateway — Panduan Penggunaan
API Gateway di Workspace dipakai untuk mendefinisikan akses REST, mengatur metode HTTP yang diizinkan, masa berlaku token, dan mempublikasikan konfigurasi ke lingkungan publik. Anda juga bisa menguji endpoint langsung dari aplikasi.
Deskripsi singkat: mendefinisikan, mengamankan, dan meluncurkan titik akhir API untuk integrasi eksternal.
Syarat Membuka Layar Ini
Pilih satu package terlebih dahulu di Repository (daftar package aktif). Tanpa package yang dipilih, Gateway menampilkan pesan untuk memilih package atau membuka Repository.
Urutan yang Disarankan
- Pastikan package sudah aktif di Repository.
- Buka API Gateway di sidebar.
- Gunakan Create untuk mengisi kredensial, metode, masa berlaku token, dan deskripsi publikasi.
- Setelah konfigurasi siap, gunakan Test Endpoint untuk mencoba permintaan HTTP.
Penjelasan Tiap Menu
| Menu | Fungsi untuk Anda |
|---|---|
| Create | Layar utama konfigurasi API production: menampilkan alamat endpoint dan token otorisasi (bisa disalin; token bersifat rahasia). Di sini Anda mengatur metode HTTP yang diizinkan (baca, buat, ubah, hapus, dll.), kedaluwarsa token (7 / 30 / 90 hari, tanggal kustom, atau tanpa kedaluwarsa), serta deskripsi penggunaan API. Tombol publikasi hanya aktif jika deskripsi sudah diisi. |
| Test Endpoint | Alat uji permintaan: pilih metode (sesuai yang diizinkan di konfigurasi), URL, isi token, lalu atur isi body (JSON mentah, form, atau tipe lain) dan kirim permintaan untuk melihat respons di layar. Berguna untuk memastikan endpoint dan token berperilaku seperti yang diharapkan sebelum integrasi pihak ketiga. |
Bagian Penting di Layar Create
- Kredensial API — Endpoint adalah alamat layanan; token dipakai aplikasi lain untuk membuktikan izin akses. Jangan membagikan token.
- Metode yang diizinkan — Aktifkan hanya yang dibutuhkan; sistem memperingatkan jika tidak ada satupun metode yang dipilih.
- Kedaluwarsa token — Membatasi masa aktif mengurangi risiko jika token bocor; pratinjau tanggal berakhir ditampilkan di layar.
- Publikasi — Isi deskripsi penggunaan (wajib), lalu gunakan aksi publikasi agar konfigurasi disimpan ke server. Perhatikan pesan sukses atau gagal.
Tips Penggunaan
- Setelah mengubah centang metode atau masa berlaku token, biasanya perubahan ikut tersimpan mengikuti perilaku form di layar (sinkron otomatis).
- Salin endpoint dan token lewat tombol salin; jika clipboard diblokir browser, ikuti petunjuk yang muncul.
- Untuk pengujian, pastikan Test Endpoint memakai URL dan token yang sama dengan yang Anda bagikan ke tim integrasi.
Jika Ada Masalah
| Gejala | Yang bisa Anda coba |
|---|---|
| Minta pilih package | Kembali ke Repository, pilih package, lalu buka lagi API Gateway. |
| Metadata tidak ditemukan | Pastikan package punya data penyimpanan yang valid; muat ulang atau pilih package lain lalu coba lagi. |
| Tidak bisa publikasi | Isi deskripsi penggunaan sampai tombol publikasi aktif; periksa notifikasi kesalahan. |
| Test tidak sesuai harapan | Cocokkan metode dengan yang diizinkan di Create; periksa URL, token, dan isi body (format JSON, dll.). |
Hubungan dengan Modul Lain
Repository menyediakan package yang menjadi konteks Gateway. Skema dan data bisnis tetap Anda kelola di modul desain data lain; Gateway fokus pada ekspos API, kebijakan akses, dan uji cepat endpoint.