Update Data
Untuk melakukan Update Data melalui API masuk ke tab-menu Integrasi API.uan umum' :
Pada bidang integrasi API pilih/klik "[POST] /update/{id}" seperti gambar berikut ini :
Akan muncul informasi dokumentasi penggunaan Endpoint "[POST] /update/{id}"
Berikut adalah penjelasan dari setiap bagian:
- Methods: Endpoint hanya dapat diakses menggunakan metode POST.
- Headers: Diperlukan dua header, yaitu access_key dan app_key, yang harus disertakan dengan nilai kunci akses masing-masing.
- Info: Menyertakan informasi tambahan seperti ID formulir (formId) dan ID aplikasi (appId), yang mungkin berguna untuk mengidentifikasi sumber data yang diperbarui.
Terdapat 4 Tahapan dalam melakukan update data
update/step-1
Langkah pertama dari proses pembaruan formulir
URL by Id:
Ini adalah URL yang digunakan untuk melakukan pembaruan data dengan menggunakan ID tertentu. Di dalam URL, terdapat placeholder yang akan diganti dengan nilai yang sesuai saat melakukan permintaan. Placeholder tersebut adalah:
{base_url}: Base URL dari API.
{appId}: ID aplikasi yang mungkin diperlukan untuk mengidentifikasi aplikasi yang sedang digunakan.
{formId}: ID formulir atau pengaduan yang ingin diperbarui.
{id}: ID unik dari data yang ingin diperbarui.
Contoh URL: URL ini akan digunakan untuk memperbarui langkah pertama dari formulir atau pengaduan dengan ID 789.
URL by Query:
Ini adalah URL alternatif yang memungkinkan Anda melakukan pembaruan data dengan menggunakan kueri tertentu. Anda dapat menggunakan kueri untuk memfilter data yang ingin diperbarui berdasarkan nilai tertentu pada bidang tertentu.
Contoh kueri: Dalam contoh ini, Anda akan menggunakan kueri untuk memfilter data yang memiliki nilai value pada bidang field.
Body:
Ini adalah bagian dari permintaan yang berisi data yang ingin diperbarui. Dalam langkah pertama ini, ada tiga bidang yang dapat diperbarui:
judul: Sebuah input yang mewakili judul dari formulir atau pengaduan.
deskripsi: Sebuah textarea yang mewakili deskripsi atau rincian lebih lanjut tentang formulir atau pengaduan.
foto: Sebuah bidang yang mungkin berupa foto yang dapat diambil menggunakan kamera perangkat atau dipilih dari galeri.
update/step-2
Langkah kedua dari proses pembaruan formulir
URL by Id:
URL yang digunakan untuk melakukan pembaruan data dengan menggunakan ID tertentu. Di dalam URL, terdapat placeholder yang akan diganti dengan nilai yang sesuai saat melakukan permintaan. Placeholder tersebut adalah:
{base_url}: Base URL dari API.
{appId}: ID aplikasi yang mungkin diperlukan untuk mengidentifikasi aplikasi yang sedang digunakan.
{formId}: ID formulir atau pengaduan yang ingin diperbarui.
{id}: ID unik dari data yang ingin diperbarui.
Contoh URL: URL ini akan digunakan untuk memperbarui langkah pertama dari formulir atau pengaduan dengan ID 789.
URL by Query:
Ini adalah URL alternatif yang memungkinkan Anda melakukan pembaruan data dengan menggunakan kueri tertentu. Anda dapat menggunakan kueri untuk memfilter data yang ingin diperbarui berdasarkan nilai tertentu pada bidang tertentu.
Contoh kueri: Dalam contoh ini, Anda akan menggunakan kueri untuk memfilter data yang memiliki nilai value pada bidang field.
Body:
Ini adalah bagian dari permintaan yang berisi data yang ingin diperbarui. Dalam langkah kedua ini, hanya ada satu bidang yang dapat diperbarui:
status: Sebuah input radio yang mewakili status dari formulir atau pengaduan. Status yang mungkin adalah PENDING, PROSES, DITOLAK, atau SELESAI.
update/step-pengiriman
Langkah ketiga dari step pembaharuan formulir adalah pengiriman
URL by Id:
URL yang digunakan untuk melakukan pembaruan data dengan menggunakan ID tertentu. Di dalam URL, terdapat placeholder yang akan diganti dengan nilai yang sesuai saat melakukan permintaan. Placeholder tersebut adalah:
{base_url}: Base URL dari API.
{appId}: ID aplikasi yang mungkin diperlukan untuk mengidentifikasi aplikasi yang sedang digunakan.
{formId}: ID formulir atau pengaduan yang ingin diperbarui.
{id}: ID unik dari data yang ingin diperbarui.
Contoh URL: URL ini akan digunakan untuk memperbarui langkah pertama dari formulir atau pengaduan dengan ID 789.
URL by Query:
Ini adalah URL alternatif yang memungkinkan Anda melakukan pembaruan data dengan menggunakan kueri tertentu. Anda dapat menggunakan kueri untuk memfilter data yang ingin diperbarui berdasarkan nilai tertentu pada bidang tertentu.
Contoh kueri: Dalam contoh ini, Anda akan menggunakan kueri untuk memfilter data yang memiliki nilai value pada bidang field.
Body:
Permintaan yang berisi data yang ingin diperbarui. Dalam langkah ketiga ini, terdapat dua bidang yang dapat diperbarui:
no_resi: Sebuah bidang untuk mengisi nomor resi atau nomor pelacakan pengiriman.
catatan: Sebuah bidang untuk mengisi catatan tambahan atau instruksi terkait pengiriman.
update/step-pembayaran
Langkah keempat dari step pembaharuan formulir adalah pembayaran
URL by Id:
URL yang digunakan untuk melakukan pembaruan data dengan menggunakan ID tertentu. Placeholder seperti {base_url}, {appId}, {formId}, dan {id}. Placeholder tersebut adalah:
{base_url}: Base URL dari API.
{appId}: ID aplikasi yang mungkin diperlukan untuk mengidentifikasi aplikasi yang sedang digunakan.
{formId}: ID formulir atau pengaduan yang ingin diperbarui.
{id}: ID unik dari data yang ingin diperbarui.
Contoh URL: URL ini akan digunakan untuk memperbarui langkah pertama dari formulir atau pengaduan dengan ID 789.
URL by Query:
Ini adalah URL alternatif yang memungkinkan Anda melakukan pembaruan data dengan menggunakan kueri tertentu. Anda dapat menggunakan kueri untuk memfilter data yang ingin diperbarui berdasarkan nilai tertentu pada bidang tertentu.
Contoh kueri: Dalam contoh ini, Anda akan menggunakan kueri untuk memfilter data yang memiliki nilai value pada bidang field.
Body:
Bagian ini berisi data yang ingin diperbarui dalam permintaan. Dalam langkah pembayaran ini, terdapat dua bidang yang dapat diperbarui:
va: Sebuah bidang yang digunakan untuk mengisi nomor virtual account jika metode pembayaran adalah VA (Virtual Account) dan gateway pembayaran di sisi pengguna.
catatan: Sebuah bidang yang digunakan untuk mengisi catatan tambahan atau instruksi terkait dengan pembayaran.
Jadi, ketika melakukan permintaan pembaruan dengan menggunakan URL atau kueri tertentu, Anda juga harus menyertakan data yang ingin diperbarui dalam format yang ditentukan di dalam body permintaan.
Last updated
