diff --git a/DOKUMENTASI_API.md b/DOKUMENTASI_API.md index 394c121..5d557e9 100644 --- a/DOKUMENTASI_API.md +++ b/DOKUMENTASI_API.md @@ -6,7 +6,7 @@ Berikut adalah rangkuman teknis dokumentasi API **Teraskota Magelang (Ora Ribet ## 1\. Ikhtisar Umum -[cite\_start]API ini menggunakan arsitektur **REST** dengan komunikasi via **HTTP** dan format pertukaran data menggunakan **JSON**[cite: 3]. +API ini menggunakan arsitektur **REST** dengan komunikasi via **HTTP** dan format pertukaran data menggunakan **JSON**[cite: 3]. * **Base URL:** `https://api.integrasvc.id` (Berdasarkan URL pada endpoint) * **Content-Type:** `application/json` @@ -15,10 +15,10 @@ Berikut adalah rangkuman teknis dokumentasi API **Teraskota Magelang (Ora Ribet Setiap permintaan (request) ke API wajib menyertakan kredensial keamanan di dalam **Header**. - * [cite\_start]**Metode:** Basic Authentication[cite: 6]. + * **Metode:** Basic Authentication[cite: 6]. * **Mekanisme:** Mengirimkan *username* dan *password* yang telah dikodekan (encoded) dalam header setiap request. - * [cite\_start]**Catatan:** Kredensial (User & Password) diberikan terpisah dari dokumen teknis ini dan wajib dijaga kerahasiaannya oleh client[cite: 7, 8]. - * [cite\_start]**Access Token:** Dokumen juga menyebutkan aplikasi client harus menyertakan access token pada header, pastikan untuk mengecek apakah ini token statis atau dinamis bersamaan dengan Basic Auth[cite: 4]. + * **Catatan:** Kredensial (User & Password) diberikan terpisah dari dokumen teknis ini dan wajib dijaga kerahasiaannya oleh client[cite: 7, 8]. + * **Access Token:** Dokumen juga menyebutkan aplikasi client harus menyertakan access token pada header, pastikan untuk mengecek apakah ini token statis atau dinamis bersamaan dengan Basic Auth[cite: 4]. ----- @@ -28,8 +28,8 @@ Setiap permintaan (request) ke API wajib menyertakan kredensial keamanan di dala Mengambil daftar program bantuan yang tersedia. - * [cite\_start]**URL:** `https://api.integrasvc.id/pbn3z` [cite: 10] - * [cite\_start]**Method:** `POST` [cite: 10] + * **URL:** `https://api.integrasvc.id/pbn3z` [cite: 10] + * **Method:** `POST` [cite: 10] * **Header:** `Authorization: Basic ` * **Body Parameters:** *(Tidak disebutkan spesifik di dokumen, asumsikan kosong atau sesuai kebutuhan filter standar)* @@ -56,7 +56,7 @@ Mengambil daftar program bantuan yang tersedia. } ``` -[cite\_start]*[cite: 10]* +*[cite: 10]* ----- @@ -64,20 +64,20 @@ Mengambil daftar program bantuan yang tersedia. Menampilkan detail data penerima atau target dari jenis bantuan tertentu. - * [cite\_start]**URL:** `https://api.integrasvc.id/qv2k9` [cite: 13] - * [cite\_start]**Method:** `POST` [cite: 14] + * **URL:** `https://api.integrasvc.id/qv2k9` [cite: 13] + * **Method:** `POST` [cite: 14] * **Header:** `Authorization: Basic ` **Body Parameters:** | Parameter | Tipe Data | Keterangan | | :--- | :--- | :--- | -| `id` | Integer | [cite\_start]ID Bantuan [cite: 16] | -| `id_kec` | String | [cite\_start]ID Kecamatan [cite: 17, 18] | -| `id_kel` | String | [cite\_start]ID Kelurahan [cite: 19, 20] | -| `rw` | String | [cite\_start]Nomor RW [cite: 21, 22] | -| `rt` | String | [cite\_start]Nomor RT [cite: 23, 24] | -| `start` | String | [cite\_start]Posisi awal data (Pagination) [cite: 25, 26] | -| `limit` | String | [cite\_start]Batas jumlah data (Pagination) [cite: 27, 28] | +| `id` | Integer | ID Bantuan [cite: 16] | +| `id_kec` | String | ID Kecamatan [cite: 17, 18] | +| `id_kel` | String | ID Kelurahan [cite: 19, 20] | +| `rw` | String | Nomor RW [cite: 21, 22] | +| `rt` | String | Nomor RT [cite: 23, 24] | +| `start` | String | Posisi awal data (Pagination) [cite: 25, 26] | +| `limit` | String | Batas jumlah data (Pagination) [cite: 27, 28] | **Contoh Response:** @@ -102,7 +102,7 @@ Menampilkan detail data penerima atau target dari jenis bantuan tertentu. } ``` -[cite\_start]*[cite: 30, 31, 44-53]* +*[cite: 30, 31, 44-53]* ----- @@ -110,18 +110,18 @@ Menampilkan detail data penerima atau target dari jenis bantuan tertentu. Menampilkan data statistik atau profil rekapitulasi untuk tingkat RT berdasarkan kategori tertentu. - * [cite\_start]**URL:** `https://api.integrasvc.id/pd32v` [cite: 57] - * [cite\_start]**Method:** `POST` [cite: 60] + * **URL:** `https://api.integrasvc.id/pd32v` [cite: 57] + * **Method:** `POST` [cite: 60] * **Header:** `Authorization: Basic ` **Body Parameters:** | Parameter | Tipe Data | Keterangan | | :--- | :--- | :--- | -| `mode` | String | Pilihan mode profil. [cite\_start]Opsi: `perumahan`, `individu`, `aset`, `rtlh` [cite: 61, 87-90] | -| `id_kec` | Integer | [cite\_start]ID Kecamatan [cite: 63, 64] | -| `id_kel` | String | [cite\_start]ID Kelurahan [cite: 65, 66] | -| `rw` | String | [cite\_start]Nomor RW [cite: 67, 68] | -| `rt` | String | [cite\_start]Nomor RT [cite: 69, 70] | +| `mode` | String | Pilihan mode profil. Opsi: `perumahan`, `individu`, `aset`, `rtlh` [cite: 61, 87-90] | +| `id_kec` | Integer | ID Kecamatan [cite: 63, 64] | +| `id_kel` | String | ID Kelurahan [cite: 65, 66] | +| `rw` | String | Nomor RW [cite: 67, 68] | +| `rt` | String | Nomor RT [cite: 69, 70] | **Contoh Response:** @@ -154,7 +154,7 @@ Menampilkan data statistik atau profil rekapitulasi untuk tingkat RT berdasarkan } ``` -[cite\_start]*[cite: 75-86, 91, 102-104]* +*[cite: 75-86, 91, 102-104]* -----