REST API Service

REST API Service di TechMaju digunakan untuk mengelompokkan dan mengelola beberapa REST API Resources, menyediakan cara yang terstruktur untuk menangani endpoint API terkait dalam sebuah aplikasi.

Memahami REST API Service DocType

Tujuan: REST API Service berfungsi sebagai wadah untuk mengorganisasi dan mengelola beberapa REST API Resources. Ini memastikan pengelompokan endpoint yang terkait secara logis untuk pemeliharaan dan skalabilitas yang lebih baik.

Fungsi: DocType ini memungkinkan pengembang untuk mendefinisikan dan mengelola koleksi resource API, menetapkan kebijakan keamanan, batasan kecepatan (rate limits), dan mengkonfigurasi pengaturan lain di tingkat layanan.

Peran yang Diperlukan

TM Core Developer: Dapat membuat, menulis, dan menghapus REST API Service.

Bidang REST API Service

Tab Detail

Bidang	Deskripsi
API ID	Pengidentifikasi unik untuk layanan API.
Aplikasi	Menentukan aplikasi tempat layanan API ini berada.
Aktif	Menunjukkan apakah layanan API ini aktif.

Tab Pengaturan

Bidang

Deskripsi

Nama

Nama pengaturan yang akan disertakan dalam permintaan API.

Tipe

Jenis pengaturan:

Header Permintaan
Parameter Query

Wajib

Memastikan pengaturan tersebut disertakan dalam permintaan API.

Tab Keamanan

Bidang	Deskripsi
Izinkan Tamu	Menentukan apakah pengguna tamu diizinkan mengakses layanan API.

Tab Pembatasan Kecepatan

Bidang	Deskripsi
Aktifkan Pembatasan Kecepatan	Toggle untuk mengaktifkan atau menonaktifkan pembatasan kecepatan.
Batas Permintaan	Jumlah maksimum permintaan yang diizinkan dalam jendela waktu yang ditentukan.
Jendela Waktu (Detik)	Jendela waktu untuk pembatasan kecepatan, ditentukan dalam detik.

Prosedur

Arahkan ke Develop > REST API Service.
Menambahkan REST API Service Baru:
- Klik '+ Add REST API Service' untuk membuka formulir pembuatan.
- Isi bidang yang diperlukan, termasuk API ID, Aplikasi, dan pengaturan lainnya.
Konfigurasi REST API Service:
- Tentukan pengaturan seperti header permintaan, kebijakan keamanan, dan pembatasan kecepatan.
- Hubungkan layanan dengan REST API Resources yang diperlukan.
Menyimpan dan Melihat REST API Service:
- Klik 'Simpan' untuk menyimpan layanan API baru.
- Layanan sekarang dapat mengelola dan mengorganisasi resource API yang terkait.

Praktik Terbaik

Organisir resource API secara logis dalam layanan untuk menyederhanakan pemeliharaan dan skalabilitas.
Terapkan langkah-langkah keamanan yang komprehensif di tingkat layanan untuk melindungi endpoint API.
Pantau penggunaan API dan sesuaikan batas kecepatan untuk memastikan kinerja dan ketersediaan yang optimal.