REST API Resource

REST API Resource adalah komponen fundamental di TechMaju, yang memungkinkan integrasi dan interaksi yang mulus dengan berbagai modul dalam aplikasi melalui endpoint RESTful.

Memahami DocType REST API Resource

Tujuan: REST API Resource memungkinkan pengembang untuk mendefinisikan endpoint yang melakukan operasi spesifik, seperti membuat, membaca, memperbarui, atau menghapus sumber daya dalam aplikasi TechMaju.

Fungsi: DocType ini memfasilitasi definisi metode HTTP (GET, POST, PUT, DELETE), jalur sumber daya, dan skrip atau metode yang sesuai untuk dijalankan. Ini memungkinkan pengaturan endpoint API khusus untuk menangani tugas-tugas tertentu dan berinteraksi dengan model data yang mendasarinya.

Peran yang Dibutuhkan

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

Bidang REST API Resource

Tab Detail

Bidang	Deskripsi
Metode HTTP	Menentukan metode HTTP yang akan digunakan: GET POST PUT PATCH DELETE
Jalur Sumber Daya	Mendefinisikan jalur endpoint untuk sumber daya API.
Aplikasi	Menentukan aplikasi yang menjadi tempat sumber daya API tersebut.
Layanan API	Menautkan sumber daya ke layanan API tertentu.
Aktif	Menunjukkan apakah sumber daya API aktif.
Skrip (Python)	Berisi skrip Python yang akan dijalankan saat endpoint diakses.

Tab Pengaturan

Bidang

Deskripsi

Nama

Nama pengaturan yang akan disertakan dalam permintaan API.

Tipe

Jenis pengaturan:

Request Header
Query Parameter

Diperlukan

Memastikan pengaturan disertakan dalam permintaan API.

Prosedur

Arahkan ke Develop > REST API Resource.
Menambahkan REST API Resource Baru:
- Klik '+ Add REST API Resource' untuk membuka formulir pembuatan.
- Isi bidang yang diperlukan, termasuk Metode HTTP, Jalur Sumber Daya, Aplikasi, Layanan API, dan Skrip.
  Lebih lanjut tentang REST API Service →
Mengonfigurasi REST API Resource:
- Definisikan header permintaan, parameter, dan format respons yang diperlukan.
- Atur opsi keamanan dan pembatasan kecepatan sesuai kebutuhan.
Menyimpan dan Melihat REST API Resource:
- Klik 'Save' untuk menyimpan sumber daya API baru.
- Endpoint baru sekarang dapat diakses sesuai definisi.

Praktik Terbaik

Uji coba endpoint API secara menyeluruh di lingkungan pengembangan sebelum menerapkan ke produksi.
Gunakan mekanisme autentikasi dan otorisasi yang tepat untuk mengamankan akses API.
Perbarui dan dokumentasikan endpoint API secara berkala untuk memastikan kejelasan dan pemeliharaan.